[PATCH 0/2] doc: pre-release doc updates

[PATCH 0/2] doc: pre-release doc updates

[Eric Wong]

I'm thinking there should be a release soonish.  The memory
usage reduction in WWW seems well worth it.

Eric Wong (2):
  README: expand on the GUI non-requirement
  doc: update notes and HACKING ahead of 1.4 release

 Documentation/RelNotes/v1.4.0.eml | 57 +++++++++++++++++++++++++++++++
 HACKING                           |  3 ++
 README                            |  3 +-
 3 files changed, 62 insertions(+), 1 deletion(-)

[PATCH 1/2] README: expand on the GUI non-requirement

[Eric Wong]

It may not be immediately obvious why we should value text-based
stuff so much, so clarify that.
---
 README | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README b/README
index a3c1e61c..b90a5298 100644
--- a/README
+++ b/README
@@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
   use of non-Free services or software.
 
 * Graphical user interfaces should not be required for text-based
-  communication.
+  communication, users may have broken graphics drivers, limited
+  eyesight, or unable to afford modern hardware.
 
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.

[PATCH 2/2] doc: update notes and HACKING ahead of 1.4 release

[Eric Wong]

There will probably be a 1.4 release in a few days...
---
 Documentation/RelNotes/v1.4.0.eml | 57 +++++++++++++++++++++++++++++++
 HACKING                           |  3 ++
 2 files changed, 60 insertions(+)

diff --git a/Documentation/RelNotes/v1.4.0.eml b/Documentation/RelNotes/v1.4.0.eml
index 0ebf8d65..b8f6c9b0 100644
--- a/Documentation/RelNotes/v1.4.0.eml
+++ b/Documentation/RelNotes/v1.4.0.eml
@@ -4,11 +4,68 @@ Subject: [WIP] public-inbox 1.4.0
 MIME-Version: 1.0
 Content-Type: text/plain; charset=utf-8
 
+This release focuses on reproducibility improvements and
+bugfixes for corner-cases.  Busy instances of PublicInbox::WWW
+may also notice memory usage reductions.
+
+Rare messages lacking Date and/or Received headers, mirrors now
+fallback to using the git author/commit times to reindex those
+messages to ensure search and filtering queries behave the same
+in mirrors as they do on the original machine.
+
+"altid" SQLite dumps are now accessible to all over the WWW
+interface via `POST /$INBOX/$ALTID.sql.gz'.
+
+Busy instances of PublicInbox::WWW (whether via
+public-inbox-httpd or another PSGI server) may notice
+significant memory usage reductions from the single message
+"permalink" lifetime optimization.  There also ongoing work to
+improve memory lifetime management to reduce the potential for
+memory fragmentation in daemons.
+
+* general changes:
+
+  - `include.*' directives in the public-inbox-config(5) file
+    are now honored as documented in git-config(1),
+    thanks to Andreas Rottmann.
+
+  - `+0000' is assumed for dates missing TZ offsets;
+    thanks to Leah Neukirchen for spotting this regression from
+    v1.2.0.
+
+  - `<' and `>' characters are dropped to avoid errors in git
+    in addresses for git, thanks again to Leah for noticing
+    this long-standing bug.
+
 * PublicInbox::WWW:
+
   - reduced memory use for single message "permalink" view
+  - code preload improved to reduce memory fragmentation
   - remove redundant "a=" parameter in links to solver
   - escape '&' in hrefs properly
   - fix optional address obfuscation in search results
+  - `POST /$INBOX/$ALTID.sql.gz' endpoint to retrieve SQLite dumps
+
+* public-inbox-httpd + public-inbox-nntpd:
+
+  - fix SIGUSR2 upgrade in worker-less instances (-W0)
+
+* public-inbox-httpd:
+
+  - fix RFC 7230 conformance when Content-Length and "chunked"
+    are both specified
+
+* public-inbox-index:
+
+  - reproduce original date and time stamps in mirrors for messages
+    lacking Date: and/or Received: headers
+
+  - new `--compact' (or `-c') switch to perform the equivalent of
+    public-inbox-compact(1) after indexing each inbox
+
+* documentation:
+
+  - Documentation/technical/data_structures.txt add for new hackers.
 
 Please report bugs via plain-text mail to: meta@public-inbox.org
 
diff --git a/HACKING b/HACKING
index 5e02302c..cceb686f 100644
--- a/HACKING
+++ b/HACKING
@@ -56,6 +56,9 @@ requirements.
 See design_www.txt and design_notes.txt in the Documentation/
 directory for design decisions made during development.
 
+See Documentation/technical/ in the source tree for more details
+on specific topics, in particular data_structures.txt
+
 Perl notes
 ----------
 

Re: [PATCH 1/2] README: expand on the GUI non-requirement

[Kyle Meyer]

Eric Wong <e@yhbt.net> writes:

> diff --git a/README b/README
> index a3c1e61c..b90a5298 100644
> --- a/README
> +++ b/README
> @@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
>    use of non-Free services or software.
>  
>  * Graphical user interfaces should not be required for text-based
> -  communication.
> +  communication, users may have broken graphics drivers, limited
> +  eyesight, or unable to afford modern hardware.

This run-on sentence tripped me up.  For clarity, perhaps add "as" or
something similar before "users"?

Re: [PATCH 1/2] README: expand on the GUI non-requirement

[Eric Wong]

Kyle Meyer <kyle@kyleam.com> wrote:
> Eric Wong <e@yhbt.net> writes:
> 
> > diff --git a/README b/README
> > index a3c1e61c..b90a5298 100644
> > --- a/README
> > +++ b/README
> > @@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
> >    use of non-Free services or software.
> >  
> >  * Graphical user interfaces should not be required for text-based
> > -  communication.
> > +  communication, users may have broken graphics drivers, limited
> > +  eyesight, or unable to afford modern hardware.
> 
> This run-on sentence tripped me up.  For clarity, perhaps add "as" or
> something similar before "users"?

Thanks and good point about the run-on sentence.

"as" could work, I think, the sentence may just be too long.
Perhaps just a separate sentence:

	"communication.  Users ..."

Thoughts?

I find it hard to notice my own grammar and speling errors,
so these fixes are very much appreciated :>

Re: [PATCH 1/2] README: expand on the GUI non-requirement

[Kyle Meyer]

Eric Wong <e@yhbt.net> writes:

> Thanks and good point about the run-on sentence.
>
> "as" could work, I think, the sentence may just be too long.
> Perhaps just a separate sentence:
>
> 	"communication.  Users ..."
>
> Thoughts?

A separate sentence reads well to me.  Thanks.

Re: [PATCH 1/2] README: expand on the GUI non-requirement

[Eric Wong]

Kyle Meyer <kyle@kyleam.com> wrote:
> Eric Wong <e@yhbt.net> writes:
> 
> > Thanks and good point about the run-on sentence.
> >
> > "as" could work, I think, the sentence may just be too long.
> > Perhaps just a separate sentence:
> >
> > 	"communication.  Users ..."
> >
> > Thoughts?
> 
> A separate sentence reads well to me.  Thanks.

Thanks for the extra eyes, slightly more awake now and it's
coherent :)
Pushed as commit ee9d839a137ad4f735e77d6b9e01698c8391006e

Diff inlined anyways for solver SEO:

diff --git a/README b/README
index a3c1e61c..2412e40f 100644
--- a/README
+++ b/README
@@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
   use of non-Free services or software.
 
 * Graphical user interfaces should not be required for text-based
-  communication.
+  communication.  Users may have broken graphics drivers, limited
+  eyesight, or unable to afford modern hardware.
 
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.

Re: [PATCH 1/2] README: expand on the GUI non-requirement

[Kyle Meyer]

Eric Wong <e@yhbt.net> writes:

> Kyle Meyer <kyle@kyleam.com> wrote:
>> Eric Wong <e@yhbt.net> writes:
>> 
>> > Thanks and good point about the run-on sentence.
>> >
>> > "as" could work, I think, the sentence may just be too long.
>> > Perhaps just a separate sentence:
>> >
>> > 	"communication.  Users ..."
>> >
>> > Thoughts?
>> 
>> A separate sentence reads well to me.  Thanks.
>
> Thanks for the extra eyes, slightly more awake now and it's
> coherent :)
> Pushed as commit ee9d839a137ad4f735e77d6b9e01698c8391006e
>
> Diff inlined anyways for solver SEO:
>
> diff --git a/README b/README
> index a3c1e61c..2412e40f 100644
> --- a/README
> +++ b/README
> @@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
>    use of non-Free services or software.
>  
>  * Graphical user interfaces should not be required for text-based
> -  communication.
> +  communication.  Users may have broken graphics drivers, limited
> +  eyesight, or unable to afford modern hardware.

Sorry, of course I spotted a missing word only after reading it again.

-- >8 --
Subject: [PATCH] README: add a missing "be"

---
 README | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README b/README
index 2412e40f..ae428bcf 100644
--- a/README
+++ b/README
@@ -15,7 +15,7 @@ public-inbox spawned around three main ideas:
 
 * Graphical user interfaces should not be required for text-based
   communication.  Users may have broken graphics drivers, limited
-  eyesight, or unable to afford modern hardware.
+  eyesight, or be unable to afford modern hardware.
 
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.
-- 
2.26.0

Re: [PATCH] README: add a missing "be"

[Eric Wong]

Kyle Meyer <kyle@kyleam.com> wrote:
> Sorry, of course I spotted a missing word only after reading it again.

> +  eyesight, or be unable to afford modern hardware.

No worries, applied and pushed.  English is tricky :<