From 3b5d3d1910f1db526a488142c01f42db5255ac72 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 19 Sep 2020 21:42:01 +0000 Subject: doc: post-1.6 updates, start 1.7 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 +- 6 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 Documentation/RelNotes/v1.7.0.wip (limited to 'Documentation') 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 -- cgit v1.2.3-24-ge0c7