user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
From: Eric Wong <>
Subject: [PATCH] doc: post-1.6 updates, start 1.7
Date: Sat, 19 Sep 2020 21:42:01 +0000
Message-ID: <> (raw)

I should've dropped "PENDING" notes before the 1.6 release;
they're dropped now, and a note is added to remind my future
self to drop them before 1.7.
 Documentation/RelNotes/v1.7.0.wip    | 16 ++++++++++++++++
 Documentation/public-inbox-index.pod | 14 +++++++-------
 Documentation/public-inbox-init.pod  |  6 +++---
 Documentation/public-inbox-learn.pod |  4 ++--
 Documentation/public-inbox-watch.pod |  2 +-
 Documentation/public-inbox-xcpdb.pod |  2 +-
 MANIFEST                             |  1 +
 Makefile.PL                          |  5 ++++-
 TODO                                 |  2 --
 9 files changed, 35 insertions(+), 17 deletions(-)
 create mode 100644 Documentation/RelNotes/v1.7.0.wip

diff --git a/Documentation/RelNotes/v1.7.0.wip b/Documentation/RelNotes/v1.7.0.wip
new file mode 100644
index 00000000..a35ff227
--- /dev/null
+++ b/Documentation/RelNotes/v1.7.0.wip
@@ -0,0 +1,16 @@
+Subject: [WIP] public-inbox 1.7.0
+MIME-Version: 1.0
+Content-Type: text/plain; charset=utf-8
+Content-Disposition: inline
+TODO: gcf2, detached indices, JMAP, ...
+* Rollbacks all the way to public-inbox 1.2.0 remain supported
+Please report bugs via plain-text mail to:
+See archives at for all history.
+See for what the future holds.
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 936516f8..0848e860 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -42,7 +42,7 @@ Influences the number of Xapian indexing shards in a
 See L<public-inbox-init(1)/--jobs> for a full description
 of sharding.
-C<--jobs=0> is accepted as of public-inbox 1.6.0 (PENDING)
+C<--jobs=0> is accepted as of public-inbox 1.6.0
 to disable parallel indexing regardless of the number of
 pre-existing shards.
@@ -102,7 +102,7 @@ This fixes some bugs in older versions of public-inbox.  While
 it is possible to use this without C<--reindex>, it makes little
 sense to do so.
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 =item --prune
@@ -133,7 +133,7 @@ significantly speed up and reduce fragmentation during the
 initial index and full C<--reindex> invocations (but not
 incremental updates).
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 =item --no-fsync
@@ -144,7 +144,7 @@ primarily intended for systems with low RAM and the small
 may even find disabling L<fdatasync(2)> causes too much dirty
 data to accumulate, resulting on latency spikes from writeback.
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 =item --sequential-shard
@@ -152,7 +152,7 @@ Sets or overrides L</publicinbox.indexSequentialShard> on a
 per-invocation basis.  See L</publicinbox.indexSequentialShard>
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 =item --skip-docdata
@@ -160,7 +160,7 @@ Stop storing document data in Xapian on an existing inbox.
 See L<public-inbox-init(1)/--skip-docdata> for description and caveats.
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
@@ -237,7 +237,7 @@ to SQLite databases.  WWW and IMAP users may notice incomplete
 search results, but it is otherwise non-fatal.  Using C<--reindex>
 will bring everything back up-to-date.
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 This is ignored on L<public-inbox-v1-format(5)> inboxes.
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index 24645045..f1ec05de 100644
--- a/Documentation/public-inbox-init.pod
+++ b/Documentation/public-inbox-init.pod
@@ -50,7 +50,7 @@ This may be set after-the-fact via C<publicinbox.$NAME.newsgroup>
 in the configuration file.  See L<public-inbox-config(5)> for more
-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 Default: none.
@@ -66,7 +66,7 @@ but may be of use to L<public-inbox-v1-format(5)> users.
 There is no automatic way to use reserved NNTP article numbers
 when old mail is found, yet.
-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 Default: unset, no NNTP article numbers are skipped
@@ -110,7 +110,7 @@ overhead by around 1.5%.
 Warning: this option prevents rollbacks to public-inbox 1.5.0
 and earlier.
-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
diff --git a/Documentation/public-inbox-learn.pod b/Documentation/public-inbox-learn.pod
index 94c96fd5..498c5092 100644
--- a/Documentation/public-inbox-learn.pod
+++ b/Documentation/public-inbox-learn.pod
@@ -55,8 +55,8 @@ not feed the message to L<spamc(1)> and only removes messages
 which match on any of the C<To:>, C<Cc:>, and C<List-ID:> headers.
 The C<--all> option may be used match C<spam> semantics in removing
-the message from all configured inboxes.  C<--all> will be
-available in public-inbox 1.6.0 (PENDING).
+the message from all configured inboxes.  C<--all> is only
+available in public-inbox 1.6.0+.
diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 73340ec4..38686645 100644
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -120,7 +120,7 @@ Messages without the (S)een flag are not considered for hiding.
 This hiding affects all configured public-inboxes in PI_CONFIG.
 As with C<publicinbox.$>, C<imap://> and C<imaps://> URLs
-are supported in public-inbox 1.6.0.
+are supported in public-inbox 1.6.0+.
 Default: none; only for L<public-inbox-watch(1)> users
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 1397a7f4..1bc1b1df 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -62,7 +62,7 @@ used with C<--compact>.
 Disable L<fsync(2)> and L<fdatasync(2)>.
 See L<public-inbox-index(1)/--no-fsync> for caveats.
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 =item --sequential-shard
diff --git a/MANIFEST b/MANIFEST
index 04a3744f..f3620de4 100644
@@ -10,6 +10,7 @@ Documentation/RelNotes/v1.3.0.eml
diff --git a/Makefile.PL b/Makefile.PL
index 3fe9acf8..f6b7abb6 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -111,8 +111,11 @@ my %man3 = map {; # semi-colon tells Perl this is a BLOCK (and not EXPR)
 } qw( WWW.pod SaPlugin/ListMirror.pod);
-	NAME => 'PublicInbox',
+	NAME => 'PublicInbox', # n.b. camel-case is not our choice
+	# XXX drop "PENDING" in .pod before updating this!
 	VERSION => '1.6.0',
 	AUTHOR => 'Eric Wong <>',
 	ABSTRACT => 'public-inbox server infrastructure',
diff --git a/TODO b/TODO
index 467f047f..8e1f4eaf 100644
--- a/TODO
+++ b/TODO
@@ -112,8 +112,6 @@ all need to be considered for everything we introduce)
 * imperfect scraper importers for obfuscated list archives
   (e.g. obfuscated Mailman stuff, Google Groups, etc...)
-* extend public-inbox-watch to support IMAP, NNTP
 * improve performance and avoid head-of-line blocking on slow storage
   (done for most git blob retrievals, Xapian needs work)

                 reply	other threads:[~2020-09-19 21:42 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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:

  List information:

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

  git send-email \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ \
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
 note: .onion URLs require Tor:

code repositories for the project(s) associated with this inbox:

AGPL code for this site: git clone