]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/design_notes.txt
import: cleanup git cat-file processes when ->done
[public-inbox.git] / Documentation / design_notes.txt
index ec1dc80084f65e1ea220e68bfaa0cf603d63fb8f..c5d9427b5d1367f36ad5b229610ee14bd96fd15a 100644 (file)
@@ -41,7 +41,7 @@ Why email?
   developers and users of Free Software should not rely on proprietary
   tools or services.
 
-* Existing infrastrucuture, tools, and user familarity.
+* Existing infrastructure, tools, and user familiarity.
   There is already a large variety of tools, clients, and email providers
   available.  There are also many resources for users to run their own
   SMTP server on a domain they control.
@@ -56,7 +56,8 @@ Why email?
 * git, one of the most widely-used version control systems, includes many
   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.
+  is based on the git mailing list: https://public-inbox.org/git/
+  (or http://hjrcffqmbrq6wope.onion/git/ for Tor users)
 
 * Email is already the de-facto form of communication in many Free Software
   communities..
@@ -86,6 +87,11 @@ Why perl 5?
 * git and SpamAssassin both use it, so it should be one less thing for
   admins to install and waste disk space with.
 
+* Distributing compiled binaries has higher costs for storage/cache
+  space is required for each architecture.  Having a runnable,
+  source-only distribution means any user already has access to all
+  of our source.
+
 Laziness
 --------
 
@@ -112,12 +118,11 @@ Laziness
 
 * Avoids bikeshedding about web UI decisions, GUI-lovers can write their
   own GUI-friendly interfaces (HTML or native) based on public archives.
-  Maybe one day integrated MUAs will feature built-in git protocol support!
 
 Web notes
 ---------
 
-* Getting users to install/run ssoma (or any new tool) is difficult.
+* Getting users to install/run any new tool is difficult.
   The web views must be easily read/cache/mirror-able.
 
 * There may also be a significant number of webmail users without
@@ -126,7 +131,7 @@ Web notes
 * Expose Message-ID in web views to encourage replies from drive-by
   contributors.
 
-* Raw text endpoint allows users to write client-side JS endpoints
+* Raw text endpoint allows users to write client-side endpoints
   without hosting the data themselves (or on a different server).
 
 What sucks about public-inbox
@@ -143,10 +148,10 @@ 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 lookup a message by Message-ID, so
+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 builtin ref rotation system based on
+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.
@@ -154,5 +159,5 @@ where `n' is the number of history splits.
 Copyright
 ---------
 
-Copyright 2013-2015 all contributors <meta@public-inbox.org>
-License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
+Copyright 2013-2018 all contributors <meta@public-inbox.org>
+License: AGPL-3.0+ <http://www.gnu.org/licenses/agpl-3.0.txt>