From 8a4b5da8df770ce57513d940afd62f0142b266b0 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 16 Feb 2020 10:24:35 +0000 Subject: 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) --- Documentation/design_www.txt | 12 +++++++++++- Documentation/txt2pre | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) (limited to 'Documentation') diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt index f15a5562..240fa504 100644 --- 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 dcef4b6c..c3a7657e 100755 --- 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) -- cgit v1.2.3-24-ge0c7