about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2015-08-20 04:15:31 +0000
committerEric Wong <e@80x24.org>2015-08-20 04:15:50 +0000
commit43c0f38b8dc27254deb10204cf97d7af7e49d368 (patch)
tree1d7b8e81397a350b958e12277c5b336429fa6065 /Documentation
parentafee3af86cd4c93e4d9bcdf1b2e34750bcff9a96 (diff)
downloadpublic-inbox-43c0f38b8dc27254deb10204cf97d7af7e49d368.tar.gz
Threading in Xapian is mostly supported by now; so start
documenting things.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/design_notes.txt2
-rw-r--r--Documentation/design_www.txt6
-rw-r--r--Documentation/include.mk6
3 files changed, 9 insertions, 5 deletions
diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt
index d7313cb6..5bb68ce5 100644
--- a/Documentation/design_notes.txt
+++ b/Documentation/design_notes.txt
@@ -144,5 +144,5 @@ where `n' is the number of history splits.
 
 Copyright
 ---------
-Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+Copyright 2013-2015, all contributors <meta@public-inbox.org>
 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index 0c38ae5f..92897043 100644
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -5,20 +5,22 @@ URL naming
 /$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
 /$LISTNAME/atom.xml                             -> Atom feed
 
+#### Optional, relies on Search::Xapian
+/$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
+
 ### Stable endpoints
 /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
 /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
 /$LISTNAME/m/$MESSAGE_ID                        -> 301 to .html version
 /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (full quotes)
 /$LISTNAME/f/$MESSAGE_ID                        -> 301 to .html version
-/$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to m/$MESSAGE_ID.txt
+/$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to ../m/$MESSAGE_ID.txt
 
 FIXME: we must refactor/cleanup/add tests for most of our CGI before
 adding more endpoints and features.
 
 Maybe TODO (these might be expensive)
 -------------------------------------
-/$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
 /$LISTNAME/t/$MESSAGE_ID.mbox                   -> mbox content of thread
 
 We use file name suffixes on all of these (except /) so URLs may easily
diff --git a/Documentation/include.mk b/Documentation/include.mk
index 162bf543..55bfc97a 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,4 +1,4 @@
-# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
 all::
 
@@ -40,7 +40,9 @@ install-man: man
         $(pandoc) -s -t man < $< > $@+ && mv $@+ $@
 
 txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && mv $@+ $@
-txt = INSTALL README COPYING
+txt := INSTALL README COPYING
+dtxt :=  design_notes.txt design_www.txt dc-dlvr-spam-flow.txt
+txt += $(addprefix Documentation/, $(dtxt))
 
 %.html: %
         $(txt2pre)