From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 825521F4B4 for ; Sat, 19 Sep 2020 21:42:01 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH] doc: post-1.6 updates, start 1.7 Date: Sat, 19 Sep 2020 21:42:01 +0000 Message-Id: <20200919214201.17889-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: 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 @@ +To: meta@public-inbox.org +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, ... + +Compatibility: + +* Rollbacks all the way to public-inbox 1.2.0 remain supported + +Please report bugs via plain-text mail to: meta@public-inbox.org + +See archives at https://public-inbox.org/meta/ for all history. +See https://public-inbox.org/TODO 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 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 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 on a per-invocation basis. See L below. -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 for description and caveats. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =back @@ -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 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 in the configuration file. See L for more info. -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 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+. =back 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 and only removes messages which match on any of the C, C, and C headers. The C<--all> option may be used match C 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+. =back 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, C and C URLs -are supported in public-inbox 1.6.0. +are supported in public-inbox 1.6.0+. Default: none; only for L 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 and L. See L 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 --- a/MANIFEST +++ b/MANIFEST @@ -10,6 +10,7 @@ Documentation/RelNotes/v1.3.0.eml Documentation/RelNotes/v1.4.0.eml Documentation/RelNotes/v1.5.0.eml Documentation/RelNotes/v1.6.0.eml +Documentation/RelNotes/v1.7.0.wip Documentation/clients.txt Documentation/dc-dlvr-spam-flow.txt Documentation/design_notes.txt 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(Git.pm Import.pm WWW.pod SaPlugin/ListMirror.pod); WriteMakefile( - 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', EXE_FILES => \@EXE_FILES, 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)