diff options
author | Eric Wong <e@80x24.org> | 2020-09-09 21:23:26 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2020-09-10 19:45:18 +0000 |
commit | a43ca1d19f3b748d6abd62c9ce8b159f1255edfb (patch) | |
tree | c69f0f9e2e1b177605eafb8d16d0de53a6f84806 /lib/PublicInbox | |
parent | aaf555cd455b46528f893ebb0f4769997fb94a74 (diff) | |
download | public-inbox-a43ca1d19f3b748d6abd62c9ce8b159f1255edfb.tar.gz |
Use the full URL of the inbox being mirrored to reduce ambiguity (instead of just the inbox name). Using asymmetric quotes (e.g `foo') improves readability for me in that it's more obvious when a quote begins and ends. It also lights up fewer pixels and reduces visual noise compared to double-quotes. We'll also reflow the `mainrepo' vs `inboxdir' comment slightly to emphasize the word `instead'.
Diffstat (limited to 'lib/PublicInbox')
-rw-r--r-- | lib/PublicInbox/WwwText.pm | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm index 87dc0751..2ed7d0d2 100644 --- a/lib/PublicInbox/WwwText.pm +++ b/lib/PublicInbox/WwwText.pm @@ -139,14 +139,16 @@ sub inbox_config ($$$) { push @$hdr, 'Content-Disposition', 'inline; filename=inbox.config'; my $name = dq_escape($ibx->{name}); my $inboxdir = '/path/to/top-level-inbox'; + my $base_url = $ibx->base_url($ctx->{env}); $$txt .= <<EOS; -; example public-inbox config snippet for "$name" -; see public-inbox-config(5) manpage for more details: +; Example public-inbox config snippet for a mirror of +; $base_url +; See public-inbox-config(5) manpage for more details: ; https://public-inbox.org/public-inbox-config.html [publicinbox "$name"] inboxdir = $inboxdir - ; note: public-inbox before v1.2.0 used "mainrepo" - ; instead of "inboxdir", both remain supported after 1.2 + ; note: public-inbox before v1.2.0 used `mainrepo' instead of + ; `inboxdir', both remain supported after 1.2 mainrepo = $inboxdir url = https://example.com/$name/ url = http://example.onion/$name/ @@ -156,7 +158,6 @@ EOS $$txt .= "\t$k = $_\n" for @$v; } if (my $altid = $ibx->{altid}) { - my $base_url = $ibx->base_url($ctx->{env}); my $altid_map = $ibx->altid_map; $$txt .= <<EOF; ; altid DBs may be used to provide numeric article ID lookup from |