user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 01/10] extsearch: rename -eindex to -extindex
Date: Sat,  7 Nov 2020 10:56:51 +0000
Message-ID: <20201107105700.12586-2-e@80x24.org> (raw)
In-Reply-To: <20201107105700.12586-1-e@80x24.org>

Upon "eindex" rhymes with "reindex", which could be confusing;
so name the command and config prefix to use "extindex" which
is hopefully less confusing.
---
 MANIFEST                                              | 2 +-
 lib/PublicInbox/Config.pm                             | 2 +-
 script/{public-inbox-eindex => public-inbox-extindex} | 4 ++--
 t/extsearch.t                                         | 6 +++---
 4 files changed, 7 insertions(+), 7 deletions(-)
 rename script/{public-inbox-eindex => public-inbox-extindex} (93%)

diff --git a/MANIFEST b/MANIFEST
index 10561cd2..fc79a134 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -225,7 +225,7 @@ sa_config/user/.spamassassin/user_prefs
 script/public-inbox-compact
 script/public-inbox-convert
 script/public-inbox-edit
-script/public-inbox-eindex
+script/public-inbox-extindex
 script/public-inbox-httpd
 script/public-inbox-imapd
 script/public-inbox-index
diff --git a/lib/PublicInbox/Config.pm b/lib/PublicInbox/Config.pm
index d425cc9b..d2010f7a 100644
--- a/lib/PublicInbox/Config.pm
+++ b/lib/PublicInbox/Config.pm
@@ -91,7 +91,7 @@ sub lookup_name ($$) {
 
 sub lookup_ei {
 	my ($self, $name) = @_;
-	$self->{-ei_by_name}->{$name} //= _fill_ei($self, "eindex.$name");
+	$self->{-ei_by_name}->{$name} //= _fill_ei($self, "extindex.$name");
 }
 
 sub each_inbox {
diff --git a/script/public-inbox-eindex b/script/public-inbox-extindex
similarity index 93%
rename from script/public-inbox-eindex
rename to script/public-inbox-extindex
index c26edb93..a58f35ca 100644
--- a/script/public-inbox-eindex
+++ b/script/public-inbox-extindex
@@ -6,7 +6,7 @@ use strict;
 use v5.10.1;
 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
 my $help = <<EOF; # the following should fit w/o scrolling in 80x24 term:
-usage: public-inbox-eindex [options] EINDEX_DIR [INBOX_DIR]
+usage: public-inbox-extindex [options] EXTINDEX_DIR [INBOX_DIR]
 
   Create and update external (detached) search indices
 
@@ -19,7 +19,7 @@ usage: public-inbox-eindex [options] EINDEX_DIR [INBOX_DIR]
   --verbose | -v      increase verbosity (may be repeated)
 
 BYTES may use `k', `m', and `g' suffixes (e.g. `10m' for 10 megabytes)
-See public-inbox-eindex(1) man page for full documentation.
+See public-inbox-extindex(1) man page for full documentation.
 EOF
 my $opt = { quiet => -1, compact => 0, max_size => undef, fsync => 1 };
 GetOptions($opt, qw(verbose|v+ reindex rethread compact|c+ jobs|j=i
diff --git a/t/extsearch.t b/t/extsearch.t
index 8d2c1507..8792fd9e 100644
--- a/t/extsearch.t
+++ b/t/extsearch.t
@@ -33,7 +33,7 @@ seek($fh, 0, SEEK_SET) or BAIL_OUT $!;
 run_script(['-mda', '--no-precheck'], $env, { 0 => $fh }) or BAIL_OUT '-mda';
 run_script(['-index', "$home/v1test"]) or BAIL_OUT "index $?";
 
-ok(run_script([qw(-eindex --all), "$home/eindex"]), 'eindex init');
+ok(run_script([qw(-extindex --all), "$home/eindex"]), 'extindex init');
 
 my $es = PublicInbox::ExtSearch->new("$home/eindex");
 {
@@ -53,8 +53,8 @@ my $es = PublicInbox::ExtSearch->new("$home/eindex");
 	my $env = { MAIL_EDITOR => "$^X -i -p -e 's/test message/BEST MSG/'" };
 	my $cmd = [ qw(-edit -Ft/utf8.eml), "$home/v2test" ];
 	ok(run_script($cmd, $env, $opt), '-edit');
-	ok(run_script([qw(-eindex --all), "$home/eindex"], undef, $opt),
-		'eindex again');
+	ok(run_script([qw(-extindex --all), "$home/eindex"], undef, $opt),
+		'extindex again');
 	like($err, qr/discontiguous range/, 'warned about discontiguous range');
 	my $msg1 = $es->over->get_art(1) or BAIL_OUT 'msg1 missing';
 	my $msg2 = $es->over->get_art(2) or BAIL_OUT 'msg2 missing';

  reply	other threads:[~2020-11-07 10:57 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-07 10:56 [PATCH 00/10] extindex: another round of updates Eric Wong
2020-11-07 10:56 ` Eric Wong [this message]
2020-11-07 10:56 ` [PATCH 02/10] extsearchidx: avoid needless alternates rewrite in ALL.git Eric Wong
2020-11-07 10:56 ` [PATCH 03/10] searchidxshard: reduce syscalls when writing ->eidx_key Eric Wong
2020-11-07 10:56 ` [PATCH 04/10] searchidxshard: further improve {current_info} readability Eric Wong
2020-11-07 10:56 ` [PATCH 05/10] v2writable: less expensive checkpoint for extindex Eric Wong
2020-11-07 10:56 ` [PATCH 06/10] extsearchidx: quiet warning for unindexed `d' messages Eric Wong
2020-11-07 10:56 ` [PATCH 07/10] extsearch: canonicalize topdir Eric Wong
2020-11-07 10:56 ` [PATCH 08/10] v2writable: more accurate {current_info} warnings/progress Eric Wong
2020-11-07 10:56 ` [PATCH 09/10] extindex: SIGUSR1 supports checkpoint Eric Wong
2020-11-07 10:57 ` [PATCH 10/10] extindex: fix --batch-size support Eric Wong

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=20201107105700.12586-2-e@80x24.org \
    --to=e@80x24.org \
    --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

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for the project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git