From: Eric Wong <e@80x24.org>
Date: Wed, 9 Sep 2020 21:23:24 +0000 (+0000)
Subject: wwwtext: describe the use of `coderepo' entries
X-Git-Tag: v1.6.0~31
X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=commitdiff_plain;h=d540575bf64e4de1512b4bf5ad8aa18247828c27

wwwtext: describe the use of `coderepo' entries

The `solver' feature is not very obvious, give potential
users a hint about it.
---

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index a691e2d8..81c0ee4a 100644
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -181,7 +181,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"};