]> Sergey Matveev's repositories - public-inbox.git/commitdiff
wwwtext: describe the use of `coderepo' entries
authorEric Wong <e@80x24.org>
Wed, 9 Sep 2020 21:23:24 +0000 (21:23 +0000)
committerEric Wong <e@80x24.org>
Thu, 10 Sep 2020 19:45:18 +0000 (19:45 +0000)
The `solver' feature is not very obvious, give potential
users a hint about it.

lib/PublicInbox/WwwText.pm

index a691e2d8efd5671770d8992d34e1f42c4feeb7ed..81c0ee4abfc889fbb9939498296e4d6cff4118a6 100644 (file)
@@ -181,7 +181,13 @@ EOF
        # and drop the original structure
        if (defined(my $cr = $ibx->{coderepo})) {
                $$txt .= "\tcoderepo = $_\n" for @$cr;
        # 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"};
                my $pi_config = $ctx->{www}->{pi_config};
                for my $cr_name (@$cr) {
                        my $urls = $pi_config->{"coderepo.$cr_name.cgiturl"};