doc: release notes and version info updates

Update release notes with some features in the 1.6 timeline.

We'll note the version availability of some command-line
options, it may help users who are reading the latest
documentation online but running older versions.

diff --git a/Documentation/RelNotes/v1.6.0.eml b/Documentation/RelNotes/v1.6.0.eml
index 283f42c898fc6d7386a87104e09c66de35688ddf..862e1c6818ad0a7531a5167fea84daf8f811d3f2 100644 (file)
--- a/Documentation/RelNotes/v1.6.0.eml
+++ b/Documentation/RelNotes/v1.6.0.eml
@@ -18,17 +18,37 @@ Content-Disposition: inline
     and indexed for search.  Use `public-inbox-index --reindex' to
     ensure these attachments are indexed in old messages.
 
     and indexed for search.  Use `public-inbox-index --reindex' to
     ensure these attachments are indexed in old messages.
 

+  - inbox.lock (v2) and ssoma.lock (v1) files are written to by
+    on message delivery (or spam removal) to wake up read-only
+    daemons via inotify or kqueue.
+

 * public-inbox-index
 
   - --batch-size=BYTES or publicinbox.indexBatchSize parameter
 
 * public-inbox-index
 
   - --batch-size=BYTES or publicinbox.indexBatchSize parameter
 

-  - parallelize updates by default, "-j0" is (once again) allowed
-    parallelization
+  - parallelize v2 updates by default, "-j0" is (once again) allowed
+    to disable parallelization
+
+  - v1 (re-)indexing parallelizes blob reads from git

 
 * public-inbox-learn
 
   - `rm' supports `--all' to remove from all configured inboxes
 
 
 * public-inbox-learn
 
   - `rm' supports `--all' to remove from all configured inboxes
 

+* public-inbox-imapd
+
+  - new read-only IMAP daemon similar to public-inbox-nntpd
+
+* public-inbox-nntpd
+
+  - blob reads from git are handled asynchronously
+
+* public-inbox-httpd
+
+  - Plack::Middleware::Deflater is no longer loaded by default
+    when no .psgi file is specified; PublicInbox::WWW gzips
+    natively (see below)
+

 * PublicInbox::WWW
 
   - use consistent blank line around attachment links
 * PublicInbox::WWW
 
   - use consistent blank line around attachment links


@@ -39,6 +59,18 @@ Content-Disposition: inline
 
   - $INBOX_DIR/description is treated as UTF-8
 
 
   - $INBOX_DIR/description is treated as UTF-8
 

+  - HTML, Atom, and text/plain responses are gzipped without
+    relying on Plack::Middleware::Deflater
+
+  - Multi-message endpoints (/t.mbox.gz, /T/, /t/, etc) are ~10% faster
+    when running under public-inbox-httpd with asynchronous blob
+    retrieval
+
+* public-inbox-watch
+
+  - Linux::Inotify2 or IO::KQueue is used directly,
+    Filesys::Notify::Simple is no longer required
+

 Please report bugs via plain-text mail to: meta@public-inbox.org
 
 See archives at https://public-inbox.org/meta/ for all history.
 Please report bugs via plain-text mail to: meta@public-inbox.org
 
 See archives at https://public-inbox.org/meta/ for all history.

diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 5be3c897bbf7f61d19d79403e08f32e740a76308..b1b24917bbb65814700c20b7dde2307eca30ca75 100644 (file)
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -46,6 +46,8 @@ This switch may be specified twice, in which case compaction
 happens both before and after indexing to minimize the temporal
 footprint of the (re)indexing operation.
 
 happens both before and after indexing to minimize the temporal
 footprint of the (re)indexing operation.
 

+Available since public-inbox 1.4.0.
+

 =item --reindex
 
 Forces a re-index of all messages in the inbox.
 =item --reindex
 
 Forces a re-index of all messages in the inbox.


@@ -70,18 +72,24 @@ is detected.  This is intended to be used in mirrors after running
 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
 is expunged from mirrors.
 
 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
 is expunged from mirrors.
 

+Available since public-inbox 1.2.0.
+

 =item --max-size SIZE
 
 Sets or overrides L</publicinbox.indexMaxSize> on a
 per-invocation basis.  See L</publicinbox.indexMaxSize>
 below.
 
 =item --max-size SIZE
 
 Sets or overrides L</publicinbox.indexMaxSize> on a
 per-invocation basis.  See L</publicinbox.indexMaxSize>
 below.
 

+Available since public-inbox 1.5.0.
+

 =item --batch-size SIZE
 
 Sets or overrides L</publicinbox.indexBatchSize> on a
 per-invocation basis.  See L</publicinbox.indexBatchSize>
 below.
 
 =item --batch-size SIZE
 
 Sets or overrides L</publicinbox.indexBatchSize> on a
 per-invocation basis.  See L</publicinbox.indexBatchSize>
 below.
 

+Available in public-inbox 1.6.0 (PENDING).
+

 =back
 
 =head1 FILES
 =back
 
 =head1 FILES

diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index 5714828d9a1da509b1cf1d79d6753419bf186e5a..fd9fc6379684e58f076efa05880fa8d41d02842a 100644 (file)
--- a/Documentation/public-inbox-init.pod
+++ b/Documentation/public-inbox-init.pod
@@ -51,6 +51,8 @@ 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).
+

 Default: unset, no NNTP article numbers are skipped
 
 =item -S, --skip-epoch
 Default: unset, no NNTP article numbers are skipped
 
 =item -S, --skip-epoch


@@ -60,6 +62,8 @@ allows archivists to publish incomplete archives with newer
 mail while allowing "0.git" (or "1.git" and so on) epochs to be
 added-after-the-fact (without affecting "git clone" followers).
 
 mail while allowing "0.git" (or "1.git" and so on) epochs to be
 added-after-the-fact (without affecting "git clone" followers).
 

+Available since public-inbox 1.2.0.
+

 Default: unset, no epochs are skipped
 
 =item -j, --jobs=JOBS
 Default: unset, no epochs are skipped
 
 =item -j, --jobs=JOBS

diff --git a/Documentation/public-inbox-learn.pod b/Documentation/public-inbox-learn.pod
index 9c6b261b3a5b2a61be637345b9c3dc932b282a85..cd9bf2782ad74bae8cbb90544aef7618d7408b22 100644 (file)
--- a/Documentation/public-inbox-learn.pod
+++ b/Documentation/public-inbox-learn.pod
@@ -55,7 +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.
+the message from all configured inboxes.  C<--all> will be
+available in public-inbox 1.6.0 (PENDING).

 
 =back
 
 
 =back