* [PATCH 6/7] doc: xcpdb: add switch documentation
2019-05-24 2:57 7% [PATCH 0/7] various documentation fixes Eric Wong
@ 2019-05-24 2:57 4% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2019-05-24 2:57 UTC (permalink / raw)
To: meta
In particular, the '--compact' switch is really useful since it
works without holding the inbox-wide lock for minutes at a time
on giant inboxes (inboxes where copies can take dozens, if not
hundreds of minutes).
---
Documentation/public-inbox-compact.pod | 10 ++++++++
Documentation/public-inbox-xcpdb.pod | 34 ++++++++++++++++++++++----
script/public-inbox-xcpdb | 2 +-
3 files changed, 40 insertions(+), 6 deletions(-)
diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 7d37f6f..47d950a 100644
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -16,6 +16,16 @@ writing while it operates.
It enforces the use of the C<--no-renumber> option of
L<xapian-compact(1)>
+=head1 OPTIONS
+
+=over
+
+=item --blocksize / --no-full / --fuller
+
+These options are passed directly to L<xapian-compact(1)>.
+
+=back
+
=head1 ENVIRONMENT
=over 8
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 5697dcd..e056b54 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -4,7 +4,7 @@ public-inbox-xcpdb - upgrade Xapian DB formats
=head1 SYNOPSIS
- public-inbox-xcpdb INBOX_DIR
+ public-inbox-xcpdb [OPTIONS] INBOX_DIR
=head1 DESCRIPTION
@@ -14,10 +14,28 @@ upgrading to the latest database format supported by Xapian
recover from Xapian database modifications from
L<public-inbox-watch(1)> or L<public-inbox-mda(1)>.
-This is intended for upgrading the database format used by
-Xapian. It DOES NOT upgrade the schema used by the
-public-inbox PSGI search interface (see
-L<public-inbox-index(1)>).
+=head1 OPTIONS
+
+=over
+
+=item --compact
+
+In addition to performing the copy operation, run L<xapian-compact(1)>
+on each Xapian partition after copying but before finalizing it.
+Compared to the cost of copying a Xapian database, compacting a
+Xapian database takes only around 5% of the time required to copy.
+
+Compared to L<public-inbox-compact(1)>, use of this option is
+preferable for gigantic inboxes where the coarse-grained lock
+currently required for L<public-inbox-compact(1)> can cause
+the compaction to take hours at-a-time.
+
+=item --blocksize / --no-full / --fuller
+
+These options are passed directly to L<xapian-compact(1)> when
+used with C<--compact>.
+
+=back
=head1 ENVIRONMENT
@@ -40,6 +58,12 @@ Default: 10000
=head1 UPGRADING
+This tool is intended for admins upgrading Xapian search databases
+used by public-inbox, NOT users upgrading public-inbox itself.
+
+In particular, it DOES NOT upgrade the schema used by the
+PSGI search interface (see L<public-inbox-index(1)>).
+
=head1 CONTACT
Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
diff --git a/script/public-inbox-xcpdb b/script/public-inbox-xcpdb
index badb95e..ef64e58 100755
--- a/script/public-inbox-xcpdb
+++ b/script/public-inbox-xcpdb
@@ -7,7 +7,7 @@ use PublicInbox::InboxWritable;
use PublicInbox::Xapcmd;
use PublicInbox::Admin;
PublicInbox::Admin::require_or_die('-search');
-my $usage = "Usage: public-inbox-xcpdb INBOX_DIR\n";
+my $usage = "Usage: public-inbox-xcpdb [--compact] INBOX_DIR\n";
my $opt = {};
GetOptions($opt, qw(compact), @PublicInbox::Xapcmd::COMPACT_OPT) or
die "bad command-line args\n$usage";
--
EW
^ permalink raw reply related [relevance 4%]
* [PATCH 0/7] various documentation fixes
@ 2019-05-24 2:57 7% Eric Wong
2019-05-24 2:57 4% ` [PATCH 6/7] doc: xcpdb: add switch documentation Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2019-05-24 2:57 UTC (permalink / raw)
To: meta
The `--compact' switch for xcpdb is really useful.
And fix a few other doc and website things while
we're at it...
Eric Wong (7):
doc: index: fix miscapitalization of "SQLite"
doc: daemon: fix manpage section for nginx
doc: don't barf on missing `git set-file-times'
doc: sync .txt mtime to .pod mtime
doc: generate manpages for some Xapian commands
doc: xcpdb: add switch documentation
doc: add URLs for Xapian manpages
Documentation/.gitignore | 1 +
Documentation/extman.perl | 33 ++++++++++++++++++++
Documentation/include.mk | 42 +++++++++++++++++++++++---
Documentation/public-inbox-compact.pod | 13 +++++++-
Documentation/public-inbox-daemon.pod | 4 +--
Documentation/public-inbox-index.pod | 2 +-
Documentation/public-inbox-xcpdb.pod | 38 +++++++++++++++++++----
script/public-inbox-xcpdb | 2 +-
8 files changed, 119 insertions(+), 16 deletions(-)
create mode 100644 Documentation/extman.perl
--
EW
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2019-05-24 2:57 7% [PATCH 0/7] various documentation fixes Eric Wong
2019-05-24 2:57 4% ` [PATCH 6/7] doc: xcpdb: add switch documentation Eric Wong
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).