user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [ssoma PATCH 2/2] README: add warnings about the lack of v2 support
Date: Wed, 19 Dec 2018 09:50:57 +0000	[thread overview]
Message-ID: <20181219095057.21862-3-e@80x24.org> (raw)
In-Reply-To: <20181219095057.21862-1-e@80x24.org>

Repositories and everything else will continue to exist; but
don't encourage people to use specialized tools when generic
ones such as NNTP will do.
---
 Documentation/ssoma_repository.pod |  4 ++++
 README                             | 15 ++++++++-------
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/Documentation/ssoma_repository.pod b/Documentation/ssoma_repository.pod
index 912f309..6929c83 100644
--- a/Documentation/ssoma_repository.pod
+++ b/Documentation/ssoma_repository.pod
@@ -6,6 +6,10 @@ ssoma_repository - repository and tree description for ssoma
 
 =head1 DESCRIPTION
 
+WARNING: this does NOT describe the scalable v2 format used
+by public-inbox.  Use of ssoma is not recommended for new
+installations due to scalability problems.
+
 ssoma uses a git repository to store each email as a git blob.
 The tree filename of the blob is based on the SHA1 hexdigest of
 the first Message-ID header.  A commit is made for each message
diff --git a/README b/README
index d2be773..de12f93 100644
--- a/README
+++ b/README
@@ -1,15 +1,13 @@
 ssoma - some sort of mail archiver
 ----------------------------------
+
+WARNING: ssoma will not be updated for public-inbox v2 repositories.
+Nowadays, public-inbox has NNTP support which makes ssoma redundant.
+
 ssoma is a git-based mail archiver and transport.  Email is injected via
 ssoma-mda(1) (MDA: mail delivery agent) on a server and may be shared
 (via git) and extracted to mbox, Maildir, or IMAP via ssoma(1).  ssoma
-exists primarily as the mechanism (not policy) for public-inbox but may
-easily be used for other projects.
-
-Readers of public-inbox instances may install ssoma to extract messages
-into their favorite mail client for reading.
-
-See http://public-inbox.org/ for more information on how ssoma is used.
+existed primarily as the mechanism (not policy) for public-inbox v1.
 
 Features
 --------
@@ -77,6 +75,9 @@ document describes it:
 
     http://ssoma.public-inbox.org/ssoma_repository.txt
 
+Again, note that this DOES NOT cover the public-inbox v2 repository
+format.
+
 Copyright
 ---------
 Copyright 2013-2016 all contributors <meta@public-inbox.org>
-- 
EW


      parent reply	other threads:[~2018-12-19  9:50 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-19  9:50 [ssoma PATCH 0/2] add warnings about lack of v2 support Eric Wong
2018-12-19  9:50 ` [ssoma PATCH 1/2] extractor: warn about v2 repositories Eric Wong
2018-12-19  9:50 ` Eric Wong [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181219095057.21862-3-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).