about summary refs log tree commit homepage
path: root/script/public-inbox-index
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-05-23 10:37:38 +0000
committerEric Wong <e@80x24.org>2019-05-23 17:43:51 +0000
commit666f1b8f5c7c76333df4e1296c1668abf04f210f (patch)
tree127e4befde4493285217e269d0b037e3829b5212 /script/public-inbox-index
parentbb279f4f305649c99dabdbcc0f45fc42c9be8e7e (diff)
downloadpublic-inbox-666f1b8f5c7c76333df4e1296c1668abf04f210f.tar.gz
-index documentation avoid redundant v1 information and refers
readers to apropriate v1/v2 manpages.  Search::Xapian can also
be optional, now, as only the PSGI search interface uses it.

Favor "INBOX_DIR" where appropriate, since "REPO_DIR" can be
confused for code repos which we also support.

XAPIAN_FLUSH_THRESHOLD is documented for all relevant
bulk commands.
Diffstat (limited to 'script/public-inbox-index')
-rwxr-xr-xscript/public-inbox-index4
1 files changed, 2 insertions, 2 deletions
diff --git a/script/public-inbox-index b/script/public-inbox-index
index b6e30528..40187b35 100755
--- a/script/public-inbox-index
+++ b/script/public-inbox-index
@@ -4,12 +4,12 @@
 # Basic tool to create a Xapian search index for a git repository
 # configured for public-inbox.
 # Usage with libeatmydata <https://www.flamingspork.com/projects/libeatmydata/>
-# highly recommended: eatmydata public-inbox-index REPO_DIR
+# highly recommended: eatmydata public-inbox-index INBOX_DIR
 
 use strict;
 use warnings;
 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
-my $usage = "public-inbox-index REPO_DIR";
+my $usage = "public-inbox-index INBOX_DIR";
 use PublicInbox::Admin;
 PublicInbox::Admin::require_or_die('-index');