user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
Search results ordered by [date|relevance]  view[summary|nested|Atom feed]
thread overview below | download mbox.gz: |
* [PATCH] doc: misc cleanups and whitespace additions
@ 2016-02-01  4:09  7% Eric Wong
  0 siblings, 0 replies; 1+ results
From: Eric Wong @ 2016-02-01  4:09 UTC (permalink / raw)
  To: meta

Add a few newlines for readability (perhaps at the expense of
economy).  Stop mentioning "Open Source" as it is redundant
and "Free Software" fits our goals, better.
---
 Documentation/design_notes.txt | 14 ++++++++++++--
 Documentation/design_www.txt   |  3 ++-
 INSTALL                        |  3 +++
 README                         | 20 +++++++++++++++++---
 4 files changed, 34 insertions(+), 6 deletions(-)

diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt
index d96c8d8..ec1dc80 100644
--- a/Documentation/design_notes.txt
+++ b/Documentation/design_notes.txt
@@ -3,6 +3,7 @@ public-inbox design notes
 
 Challenges to running normal mailing lists
 ------------------------------------------
+
 1) spam
 2) bounce processing of invalid/bad email addresses
 3) processing subscribe/unsubscribe requests
@@ -14,6 +15,7 @@ confused users who cannot unsubscribe.
 
 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)
@@ -34,6 +36,7 @@ Use existing infrastructure
 
 Why email?
 ----------
+
 * Freedom from proprietary services, tools and APIs.  Communicating with
   developers and users of Free Software should not rely on proprietary
   tools or services.
@@ -64,17 +67,19 @@ Why email?
 
 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, an NNTP gateway (read-only?) is possible.
+  integrity.  However, a read-only NNTP gateway is implemented.
 
-* As of 2014, git is widely used and known to nearly all Free Software
+* 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.
 
 Why perl 5?
 -----------
+
 * Perl 5 is widely available on modern *nix systems with good a history
   of backwards and forward compatibility.
 
@@ -83,6 +88,7 @@ Why perl 5?
 
 Laziness
 --------
+
 * Stick to dependencies available in Debian main, this should make it
   easier for potential users to install, and easier for distro
   maintainers to pick up.
@@ -110,6 +116,7 @@ Laziness
 
 Web notes
 ---------
+
 * Getting users to install/run ssoma (or any new tool) is difficult.
   The web views must be easily read/cache/mirror-able.
 
@@ -124,6 +131,7 @@ Web notes
 
 What sucks about public-inbox
 -----------------------------
+
 * Lack of push notification.  On the other hand, feeds seem popular.
 
 * some (mostly GUI) mail clients cannot set In-Reply-To headers
@@ -131,6 +139,7 @@ What sucks about public-inbox
 
 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
@@ -144,5 +153,6 @@ 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>
diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index 8763184..7601523 100644
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -16,7 +16,7 @@ URL naming
 /$LISTNAME/$MESSAGE_ID/raw                -> raw mbox
 /$LISTNAME/$MESSAGE_ID/f/                 -> HTML content (full quotes)
 
-### Legacy endpoints (may be ambiguous given Message-IDs with similar suffies)
+### Legacy endpoints (may be ambiguous given Message-IDs with similar suffixes)
 /$LISTNAME/m/$MESSAGE_ID/                 -> 301 to /$LISTNAME/$MESSAGE_ID/
 /$LISTNAME/m/$MESSAGE_ID.html             -> 301 to /$LISTNAME/$MESSAGE_ID/
 /$LISTNAME/m/$MESSAGE_ID.txt              -> 301 to /$LISTNAME/$MESSAGE_ID/raw
@@ -45,6 +45,7 @@ of the original email.
 
 Guidelines for using limited HTML
 ---------------------------------
+
 We mainly use HTML for linking pages together with <a>.
 We also set <title> to make window management easier.
 
diff --git a/INSTALL b/INSTALL
index bb68294..538a95d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,6 @@
 public-inbox (server-side) installation
 ---------------------------------------
+
 This is for folks who want to setup their own public-inbox instance.
 Clients should see http://ssoma.public-inbox.org/INSTALL.html instead
 if they want to import mail into their personal inboxes.
@@ -20,6 +21,7 @@ standard MakeMaker installation (Perl)
 
 Requirements (server MDA)
 -------------------------
+
 * git
 * ssoma - http://ssoma.public-inbox.org/INSTALL.html
 * SpamAssassin (spamc/spamd)
@@ -55,5 +57,6 @@ Optional modules:
 
 Copyright
 ---------
+
 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/README b/README
index 09b66a3..85b48be 100644
--- a/README
+++ b/README
@@ -1,5 +1,6 @@
 public-inbox - an "archives first" approach to mailing lists
 ------------------------------------------------------------
+
 public-inbox implements the sharing of an email inbox via git to
 complement or replace traditional mailing lists.  Readers may
 read via NNTP, Atom feeds or HTML archives.
@@ -7,9 +8,11 @@ read via NNTP, Atom feeds or HTML archives.
 public-inbox spawned around three main ideas:
 
 * Publically accessible and archived communication is essential to
-  Free and Open Source development.
-* Contributing to Free and Open Source projects should not require the
-  use of non-Free/non-Open Source services or software.
+  Free Software development.
+
+* Contributing to Free Software projects should not require the
+  use of non-Free services or software.
+
 * Graphical user interfaces should not be required for text-based
   communication.
 
@@ -18,6 +21,7 @@ to run their own instances with minimal overhead.
 
 Implementation
 --------------
+
 public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
 no policy of its own.  By storing (and optionally) exposing an inbox
 via git, it is fast and efficient to host and mirror public-inboxes.
@@ -47,9 +51,13 @@ replay a public-inbox git archive to subscribers via SMTP.
 
 Features
 --------
+
 * anybody may participate via plain-text email
+
 * stores email in git, readers may have a complete archive of the inbox
+
 * Atom feed and NNTP allows casual readers to follow via feed reader
+
 * uses only well-documented and easy-to-implement data formats
 
 Try it out now, see http://try.public-inbox.org/
@@ -73,10 +81,12 @@ Requirements (participant)
 
 Requirements (server)
 ---------------------
+
 See http://public-inbox.org/INSTALL
 
 Hacking
 -------
+
 Source code is available via git:
 
 	git clone git://80x24.org/public-inbox
@@ -85,6 +95,7 @@ See below for contact info.
 
 Contact
 -------
+
 We are happy to see feedback of all types via plain-text email.
 public-inbox discussion is self-hosting on public-inbox.org
 Please send comments, user/developer discussion, patches, bug reports,
@@ -112,6 +123,7 @@ Or pass the same git repository URL for ssoma using the instructions at:
 
 Anti-Spam
 ---------
+
 The maintainer of public-inbox has found SpamAssassin a good tool for
 filtering his personal mail, and it will be the default spam filtering
 tool in public-inbox.
@@ -120,6 +132,7 @@ See http://public-inbox/dc-dlvr-spam-flow.html for more info.
 
 Content Filtering
 -----------------
+
 To discourage phishing, web bugs (tracking), viruses and other nuisances,
 only plain-text content is allowed and non-text content is stripped.
 This saves I/O bandwidth and storage, which is important as
@@ -131,6 +144,7 @@ aims to preserve the focus on content, and not presentation.
 
 Copyright
 ---------
+
 Copyright 2013-2015 all contributors <meta@public-inbox.org>
 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
 
-- 
EW


^ permalink raw reply	[relevance 7%]

Results 1-1 of 1 | reverse | sort options + mbox downloads above
-- links below jump to the message on this page --
2016-02-01  4:09  7% [PATCH] doc: misc cleanups and whitespace additions Eric Wong

Code repositories for project(s) associated with this 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).