wwwtext: config comment improvements

[public-inbox.git] / lib / PublicInbox / WwwText.pm

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index a691e2d8efd5671770d8992d34e1f42c4feeb7ed..2ed7d0d2ee09d8ba2d4c28282de08bdde9503430 100644 (file)
--- 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
@@ -181,7 +182,13 @@ EOF
        # and drop the original structure
        if (defined(my $cr = $ibx->{coderepo})) {
                $$txt .= "\tcoderepo = $_\n" for @$cr;
+               $$txt .= <<'EOF';
 
+; `coderepo' entries allows blob reconstruction via patch emails if
+; the inbox is indexed with Xapian.  `@@ <from-range> <to-range> @@'
+; line number ranges in `[PATCH]' emails link to /$INBOX_NAME/$OID/s/,
+; an HTTP endpoint which reconstructs git blobs via git-apply(1).
+EOF
                my $pi_config = $ctx->{www}->{pi_config};
                for my $cr_name (@$cr) {
                        my $urls = $pi_config->{"coderepo.$cr_name.cgiturl"};
@@ -192,11 +199,11 @@ EOF
                        if ($urls && scalar(@$urls)) {
                                $$txt .= "\t; ";
                                $$txt .= join(" ||\n\t;\t", map {;
-                                       my $cpath = $path;
+                                       my $dst = $path;
                                        if ($path !~ m![a-z0-9_/\.\-]!i) {
-                                               $cpath = dq_escape($cpath);
+                                               $dst = '"'.dq_escape($dst).'"';
                                        }
-                                       qq(git clone $_ "$cpath");
+                                       qq(git clone $_ $dst);
                                } @$urls);
                                $$txt .= "\n";
                        }