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 F15711F5AE; Tue, 14 Jul 2020 10:06:40 +0000 (UTC) Date: Tue, 14 Jul 2020 10:06:40 +0000 From: Eric Wong To: meta@public-inbox.org Subject: [PATCH] doc: release notes and version info updates Message-ID: <20200714100640.GA31695@dcvr> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline List-Id: 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. --- Documentation/RelNotes/v1.6.0.eml | 36 ++++++++++++++++++++++++++-- Documentation/public-inbox-index.pod | 8 +++++++ Documentation/public-inbox-init.pod | 4 ++++ Documentation/public-inbox-learn.pod | 3 ++- 4 files changed, 48 insertions(+), 3 deletions(-) diff --git a/Documentation/RelNotes/v1.6.0.eml b/Documentation/RelNotes/v1.6.0.eml index 283f42c89..862e1c681 100644 --- 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. + - 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 - - 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-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 @@ -39,6 +59,18 @@ Content-Disposition: inline - $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. diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index 5be3c897b..b1b24917b 100644 --- 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. +Available since public-inbox 1.4.0. + =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 or L to ensure data is expunged from mirrors. +Available since public-inbox 1.2.0. + =item --max-size SIZE Sets or overrides L on a per-invocation basis. See L below. +Available since public-inbox 1.5.0. + =item --batch-size SIZE Sets or overrides L on a per-invocation basis. See L below. +Available in public-inbox 1.6.0 (PENDING). + =back =head1 FILES diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index 5714828d9..fd9fc6379 100644 --- a/Documentation/public-inbox-init.pod +++ b/Documentation/public-inbox-init.pod @@ -51,6 +51,8 @@ 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). + 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). +Available since public-inbox 1.2.0. + 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 9c6b261b3..cd9bf2782 100644 --- a/Documentation/public-inbox-learn.pod +++ b/Documentation/public-inbox-learn.pod @@ -55,7 +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. +the message from all configured inboxes. C<--all> will be +available in public-inbox 1.6.0 (PENDING). =back