* [PATCH] misc documentation updates
@ 2015-08-20 4:17 7% Eric Wong
0 siblings, 0 replies; 1+ results
From: Eric Wong @ 2015-08-20 4:17 UTC (permalink / raw)
To: meta
Threading in Xapian is mostly supported by now; so start
documenting things.
---
Documentation/design_notes.txt | 2 +-
Documentation/design_www.txt | 6 ++++--
Documentation/include.mk | 6 ++++--
INSTALL | 9 +++++++--
Makefile.PL | 2 +-
README | 2 +-
6 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt
index d7313cb..5bb68ce 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 0c38ae5..9289704 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 162bf54..55bfc97 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)
diff --git a/INSTALL b/INSTALL
index 0e9ab6d..14126d5 100644
--- a/INSTALL
+++ b/INSTALL
@@ -25,7 +25,6 @@ Requirements (server MDA)
* MTA - postfix is recommended
* lynx (for converting HTML messages to text)
* Perl and several modules: (Debian package name)
- - CGI[1] perl-modules[2]
- Date::Parse libtimedate-perl
- Email::Address libemail-address-perl
- Email::Filter libemail-filter-perl
@@ -34,16 +33,22 @@ Requirements (server MDA)
- Encode::MIME::Header perl
- File::Path::Expand libfile-path-expand-perl
- IPC::Run libipc-run-perl
+
+Optional modules:
+
+ - CGI[1] perl-modules[2]
- Mail::Thread (2.5+)[1] libmail-thread-perl
- URI::Escape[1] liburi-perl
- XML::Atom::SimpleFeed[1] libxml-atom-simplefeed-perl
+ - Search::Xapian[3] libsearch-xapian-perl
[1] - Only required for serving/generating Atom and HTML pages.
[2] - Keep in mind this will be split into a separate Debian package
when CGI.pm is dropped from the Perl standard library.
Plack/PSGI and mod_perl2 are both supported.
+[3] - Optional for HTML web interface
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/Makefile.PL b/Makefile.PL
index f302b7c..277e9a2 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -1,5 +1,5 @@
#!/usr/bin/perl -w
-# 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)
use strict;
use ExtUtils::MakeMaker;
diff --git a/README b/README
index f0f2f68..d5ff118 100644
--- a/README
+++ b/README
@@ -144,7 +144,7 @@ aims to preserve the focus on content, and not presentation.
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>
This program is free software: you can redistribute it and/or modify
--
EW
^ permalink raw reply related [relevance 7%]
Results 1-1 of 1 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2015-08-20 4:17 7% [PATCH] misc documentation updates Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).