From: Eric Wong <e@yhbt.net> To: meta@public-inbox.org Subject: [PATCH] doc: release notes and version info updates Date: Tue, 14 Jul 2020 10:06:40 +0000 [thread overview] Message-ID: <20200714100640.GA31695@dcvr> (raw) 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<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. +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. +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<public-inbox-v1-format(5)> 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<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 -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
next reply other threads:[~2020-07-14 10:06 UTC|newest] Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-07-14 10:06 Eric Wong [this message] 2020-07-14 10:16 ` a note about NNTP + IMAP in -watch Eric Wong
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://public-inbox.org/README * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200714100640.GA31695@dcvr \ --to=e@yhbt.net \ --cc=meta@public-inbox.org \ --subject='Re: [PATCH] doc: release notes and version info updates' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/public-inbox.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).