]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: post-1.6 updates, start 1.7
authorEric Wong <e@80x24.org>
Sat, 19 Sep 2020 21:42:01 +0000 (21:42 +0000)
committerEric Wong <e@80x24.org>
Sat, 26 Dec 2020 19:30:34 +0000 (19:30 +0000)
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.

(cherry picked from commit 3b5d3d1910f1db526a488142c01f42db5255ac72)

Documentation/RelNotes/v1.7.0.wip [new file with mode: 0644]
Documentation/public-inbox-index.pod
Documentation/public-inbox-init.pod
Documentation/public-inbox-learn.pod
Documentation/public-inbox-watch.pod
Documentation/public-inbox-xcpdb.pod
MANIFEST
Makefile.PL
TODO

diff --git a/Documentation/RelNotes/v1.7.0.wip b/Documentation/RelNotes/v1.7.0.wip
new file mode 100644 (file)
index 0000000..a35ff22
--- /dev/null
@@ -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.
index 936516f808eaa52b15b4248a2ea91317cfbfae8d..0848e8604c8aa842a9fdcda6aec4026a45f9442b 100644 (file)
@@ -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.
 
 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.
 
 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.
 
 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
 
 
 =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).
 
 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
 
 
 =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.
 
 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
 
 
 =item --sequential-shard
 
@@ -152,7 +152,7 @@ Sets or overrides L</publicinbox.indexSequentialShard> on a
 per-invocation basis.  See L</publicinbox.indexSequentialShard>
 below.
 
 per-invocation basis.  See L</publicinbox.indexSequentialShard>
 below.
 
-Available in public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 
 =item --skip-docdata
 
 
 =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.
 
 
 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+.
 
 =back
 
 
 =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.
 
 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.
 
 
 This is ignored on L<public-inbox-v1-format(5)> inboxes.
 
index 2464504539749f314b4e054b10f1d97e72b8d680..f1ec05de0a5e2bbad426153715cf7f64f37dbdb8 100644 (file)
@@ -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
 info.
 
 in the configuration file.  See L<public-inbox-config(5)> for more
 info.
 
-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.
 
 Default: none.
 
 
 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.
 
 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
 
 
 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.
 
 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
 
 
 =back
 
index 94c96fd5a469f26ec9b4d22f3dff670244b42158..498c5092cfd397fd2166c00618d3da31bbc87c1e 100644 (file)
@@ -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
 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+.
 
 =back
 
 
 =back
 
index 73340ec486f4accb2ac79457ea2b2fd9efa4e4c2..386866450db7044a198e8676b006d19457076ffe 100644 (file)
@@ -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.$NAME.watch>, C<imap://> and C<imaps://> URLs
 This hiding affects all configured public-inboxes in PI_CONFIG.
 
 As with C<publicinbox.$NAME.watch>, 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
 
 
 Default: none; only for L<public-inbox-watch(1)> users
 
index 1397a7f4ef156d8527780eca99489de734e4b920..1bc1b1dfcc9be471a11d7ec2e3df4ead5453bc81 100644 (file)
@@ -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.
 
 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
 
 
 =item --sequential-shard
 
index 04a3744f9cc8a3a7d251e1ddf7cd9ffe5dfdfc90..f3620de4682f98c21860ceeab4eaa0d0ee894983 100644 (file)
--- 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.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
 Documentation/clients.txt
 Documentation/dc-dlvr-spam-flow.txt
 Documentation/design_notes.txt
index 3fe9acf80bc03321b70383d071adcfcf05035c1c..f6b7abb65647164193f576a78fb688f9593212e5 100644 (file)
@@ -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(
 } 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',
        VERSION => '1.6.0',
+
        AUTHOR => 'Eric Wong <e@80x24.org>',
        ABSTRACT => 'public-inbox server infrastructure',
        EXE_FILES => \@EXE_FILES,
        AUTHOR => 'Eric Wong <e@80x24.org>',
        ABSTRACT => 'public-inbox server infrastructure',
        EXE_FILES => \@EXE_FILES,
diff --git a/TODO b/TODO
index 467f047f10185cddd6e9783f657215b251d6f2fd..8e1f4eaf1298e00a1886cf393538f0046868e15e 100644 (file)
--- 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...)
 
 * 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)
 
 * improve performance and avoid head-of-line blocking on slow storage
   (done for most git blob retrievals, Xapian needs work)