doc: design_www: document solver endpoint

The blob regeneration (solving) part has been stable and
performant for over a year with no problems, even with web
crawlers constantly hitting it without needing rate limits.

All the other stuff is open to bikeshedding (as long as
my crappy hardware supports it :P)

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index f15a55629745869ab34f4d0735c337d5b5035b31..240fa5046b35bc12a3dad7aca7d567d376e6a609 100644 (file)
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -7,7 +7,7 @@ URL and anchor naming
 /$INBOX/?r=$GIT_COMMIT                 -> HTML only
 /$INBOX/new.atom                       -> Atom feed
 
-#### Optional, relies on Search::Xapian
+#### Optional, relies on Search::Xapian (or Xapian SWIG binding)
 /$INBOX/$MESSAGE_ID/t/                 -> HTML content of thread (nested)
 /$INBOX/$MESSAGE_ID/T/                 -> HTML content of thread (flat)
        anchors:
@@ -21,6 +21,16 @@ URL and anchor naming
 /$INBOX/$MESSAGE_ID/t.atom             -> Atom feed for thread
 /$INBOX/$MESSAGE_ID/t.mbox.gz          -> gzipped mbox of thread
 
+/$INBOX/$GIT_OID/s/                    -> "git show" (via "git apply")
+       This endpoint requires "coderepo" entries configured for
+       a given inbox.  It can recreate ("solve") blobs from
+       patch emails using Xapian and git-apply(1).  It can also
+       display non-blob content, but that remains a
+       work-in-progress.
+
+/$INBOX/$GIT_OID/s/$FILENAME           -> "git show", raw output
+       As above, but shows the raw (usually text/plain) output.
+
 ### Stable endpoints
 /$INBOX/$MESSAGE_ID/                   -> HTML content
        anchors:

diff --git a/Documentation/txt2pre b/Documentation/txt2pre
index dcef4b6cc83e541bb43adbcdcd7dd0e0c2397ce5..c3a7657e6157a216c864d6f22bb1c514fe4eb817 100755 (executable)
--- a/Documentation/txt2pre
+++ b/Documentation/txt2pre
@@ -46,6 +46,7 @@ for (qw[flock(2) setrlimit(2) vfork(2)]) {
 
 for (qw[git(1)
        git-am(1)
+       git-apply(1)
        git-config(1)
        git-daemon(1)
        git-fetch(1)