unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 2/3] www_text/mirror: spell out "external index" and "public inbox"
Date: Mon, 30 Aug 2021 23:44:53 +0000	[thread overview]
Message-ID: <20210830234454.32422-3-e@80x24.org> (raw)
In-Reply-To: <20210830234454.32422-1-e@80x24.org>

"extindex" and "public-inbox" are project-specific terms which
are probably unsuitable for folks who are seeing this for the
first time.

Use "public inbox" when referring to actual public inboxes,
since "public-inbox" is merely the name for this particular
implementation and others have adopted the same concept (IMHO
the concept is more important than any particular
implementation).
---
 lib/PublicInbox/WwwText.pm | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index 858fc2f7..fabe39f6 100644
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -246,9 +246,13 @@ sub coderepos_raw ($$) {
 	my $cfg = $ctx->{www}->{pi_cfg};
 	my @ret;
 	for my $cr_name (@$cr) {
-		$ret[0] //= <<EOF;
-code repositories for project(s) associated with this inbox:
+		$ret[0] //= do {
+			my $thing = $ctx->{ibx}->can('cloneurl') ?
+				'public inbox' : 'external index';
+			<<EOF;
+Code repositories for project(s) associated with this $thing
 EOF
+		};
 		my $urls = $cfg->get_all("coderepo.$cr_name.cgiturl");
 		if ($urls) {
 			for (@$urls) {
@@ -276,7 +280,8 @@ sub _mirror_help ($$) {
 	$top_url =~ s!/[^/]+\z!/!;
 	$$txt .= "public-inbox mirroring instructions\n\n";
 	if ($ibx->can('cloneurl')) { # PublicInbox::Inbox
-		$$txt .= "This inbox may be cloned and mirrored by anyone:\n";
+		$$txt .=
+		  "This public inbox may be cloned and mirrored by anyone:\n";
 		my @urls;
 		my $max = $ibx->max_git_epoch;
 		# TODO: some of these URLs may be too long and we may need to
@@ -322,8 +327,8 @@ EOF
 		}
 	} else { # PublicInbox::ExtSearch
 		$$txt .= <<EOM;
-This is an extindex which is an amalgamation of several public-inboxes.
-Each public-inbox needs to be mirrored individually.
+This is an external index which is an amalgamation of several public inboxes.
+Each public inbox needs to be mirrored individually.
 EOM
 		my $v = $ctx->{www}->{pi_cfg}->{lc('publicInbox.wwwListing')};
 		if (($v // '') =~ /\A(?:all|match=domain)\z/) {

  parent reply	other threads:[~2021-08-30 23:44 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-16 16:36 RFE: Long .onion URL breaks mobile view Konstantin Ryabitsev
2021-08-16 22:38 ` Eric Wong
2021-08-16 22:53   ` Eric Wong
2021-08-26 12:33 ` [PATCH 0/8] various WWW + extindex stuff Eric Wong
2021-08-26 12:33   ` [PATCH 1/8] get rid of unnecessary bytes::length usage Eric Wong
2021-08-26 12:33   ` [PATCH 2/8] ds: use bytes::substr and bytes::length module-wide for now Eric Wong
2021-08-26 12:33   ` [PATCH 3/8] www_stream: sh-friendly .onion URLs wrapping Eric Wong
2021-08-26 12:33   ` [PATCH 4/8] www: avoid incorrect instructions for extindex Eric Wong
2021-08-26 12:33   ` [PATCH 5/8] www_text: fix example config snippet " Eric Wong
2021-08-26 12:33   ` [PATCH 6/8] config: do not parse altid " Eric Wong
2021-08-26 12:33   ` [PATCH 7/8] www_text: add coderepo config support " Eric Wong
2021-08-26 12:33   ` [PATCH 8/8] move ->ids_after from mm to over Eric Wong
2021-08-26 13:27   ` [PATCH 0/8] various WWW + extindex stuff Konstantin Ryabitsev
2021-08-28 11:50     ` [PATCH 0/2] www: split out mirror to /text/ Eric Wong
2021-08-28 11:50       ` [PATCH 1/2] www: move mirror instructions " Eric Wong
2021-08-28 11:50       ` [PATCH 2/2] www_stream: description header links to top $INBOX_URL Eric Wong
2021-08-28 17:58       ` [PATCH 0/2] www: split out mirror to /text/ Konstantin Ryabitsev
2021-08-30 23:44         ` [PATCH 0/3] www: more footer and mirroring instructions tweaks Eric Wong
2021-08-30 23:44           ` [PATCH 1/3] www_stream: extra link to mirroring information in the footer Eric Wong
2021-08-30 23:44           ` Eric Wong [this message]
2021-08-30 23:44           ` [PATCH 3/3] www_listing: add note about mirroring information 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=20210830234454.32422-3-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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).