From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH] doc: recommend -compact after --reindex
Date: Tue, 4 Feb 2020 21:44:04 +0000 [thread overview]
Message-ID: <20200204214404.6221-1-e@yhbt.net> (raw)
It's likely a user will be low on space after running --reindex,
so recommend the use of public-inbox-compact afterwards.
And add a few more notes about using public-inbox-compact to
clarify it's for inboxes-only (and not any old Xapian DBs) that
using xapian-compact(1) directly is error-prone and likely to
break things.
---
Documentation/public-inbox-compact.pod | 5 +++--
Documentation/public-inbox-index.pod | 3 ++-
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 20f9d475..6b0c7376 100644
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -1,6 +1,6 @@
=head1 NAME
-public-inbox-compact - compact Xapian DBs
+public-inbox-compact - compact Xapian DBs in an inbox
=head1 SYNOPSIS
@@ -14,7 +14,8 @@ L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
writing while it operates.
It enforces the use of the C<--no-renumber> option of
-L<xapian-compact(1)>
+L<xapian-compact(1)> which is required to work with the
+rest of the public-inbox search code.
=head1 OPTIONS
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 610dacbe..6dc6a3aa 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -38,7 +38,8 @@ Forces a search engine re-index of all messages in the
repository. This can be used for in-place upgrades while
NNTP/HTTP server processes are utilizing the index. Keep in
mind this roughly doubles the size of the already-large
-Xapian database.
+Xapian database. Running L<public-inbox-compact(1)>
+afterwards is recommended to release free space.
This does not touch the NNTP article number database.
reply other threads:[~2020-02-04 21:44 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200204214404.6221-1-e@yhbt.net \
--to=e@yhbt.net \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).