]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/design_notes.txt
doc: design_notes: updates for "newer" things
[public-inbox.git] / Documentation / design_notes.txt
index c5d9427b5d1367f36ad5b229610ee14bd96fd15a..3df5af3e3cf204c7954830d22a0de8b7fbd1d5e1 100644 (file)
@@ -18,7 +18,7 @@ Use existing infrastructure
 
 * public-inbox can coexist with existing mailing lists, any subscriber
   to the existing mailing list can begin delivering messages to
-  public-inbox-mda(1)
+  public-inbox-mda(1) or public-inbox-watch(1)
 
 * public-inbox uses SMTP for posting.  Posting a message to a public-inbox
   instance is no different than sending a message to any _open_ mailing
@@ -27,9 +27,7 @@ Use existing infrastructure
 * Existing spam filtering on an SMTP server is also effective on
   public-inbox.
 
-* readers may continue using use their choice of mail clients and
-  mailbox formats, only learning a few commands of the ssoma(1) tool
-  is required.
+* Readers may continue using use their choice of NNTP and mail clients.
 
 * Atom is a reasonable feed format for casual readers and is supported
   by a variety of feed readers.
@@ -57,7 +55,9 @@ Why email?
   tools for for email, including: git-format-patch(1), git-send-email(1),
   git-am(1), git-imap-send(1).  Furthermore, the development of git itself
   is based on the git mailing list: https://public-inbox.org/git/
-  (or http://hjrcffqmbrq6wope.onion/git/ for Tor users)
+  (or
+  http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/git/
+  for Tor users)
 
 * Email is already the de-facto form of communication in many Free Software
   communities..
@@ -72,11 +72,12 @@ Why git?
 * git is distributed and robust while being both fast and
   space-efficient with text data.  NNTP was considered, but does not
   support delta-compression and places no guarantees on data/transport
-  integrity.  However, a read-only NNTP gateway is implemented.
+  integrity.  However, read-only IMAP and NNTP gateways are implemented.
 
 * As of 2016, git is widely used and known to nearly all Free Software
   developers.  For non-developers it is packaged for all major GNU/Linux
-  and *BSD distributions.  NNTP is not as widely-used nowadays.
+  and *BSD distributions.  NNTP is not as widely-used nowadays, and
+  most IMAP clients do not have good support for read-only mailboxes.
 
 Why perl 5?
 -----------
@@ -142,22 +143,16 @@ What sucks about public-inbox
 * some (mostly GUI) mail clients cannot set In-Reply-To headers
   properly without the original message.
 
+* marketing - as it should: <https://public-inbox.org/marketing.txt>
+
 Scalability notes
 -----------------
 
-Even with shallow clone, storing the history of large/busy mailing lists
-may place much burden on subscribers and servers.  However, having a
-single (or few) refs representing the entire history of a list is good
-for small lists since it's easier to look up a message by Message-ID, so
-we want to avoid splitting refs with independent histories.
-
-ssoma will likely grow its own built-in ref rotation system based on
-message count (not rotating at fixed time intervals).  This would
-split the histories and require O(n) lookup time based on Message-ID,
-where `n' is the number of history splits.
+See the public-inbox-v2-format(5) manpage for all the scalability
+problems solved.
 
 Copyright
 ---------
 
-Copyright 2013-2018 all contributors <meta@public-inbox.org>
+Copyright all contributors <meta@public-inbox.org>
 License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>