Re: clean up docs for v12

Michael Paquier <michael@paquier.xyz>

From: Michael Paquier <michael@paquier.xyz>
To: Justin Pryzby <pryzby@telsasoft.com>
Cc: Alvaro Herrera <alvherre@2ndquadrant.com>, Andres Freund <andres@anarazel.de>, pgsql-hackers@postgresql.org
Date: 2019-04-27T04:57:00Z
Lists: pgsql-hackers
On Fri, Apr 26, 2019 at 09:56:47PM -0500, Justin Pryzby wrote:
> But here's some one-liner excerpts.
> 
> -      is <literal>2</literal> bits and maximum is <literal>4095</literal>.  Parameters for
> +      is <literal>2</literal> bits and the maximum is <literal>4095</literal>.  Parameters for
> 
> Adding "the" makes it a complete sentence and not a fragment.

Not sure here either that it matters.

> -        all autovacuum actions. Minus-one (the default) disables logging
> +        all autovacuum actions. <literal>-1</literal> (the default) disables logging
> 
> There's nothing else that says "minus-one" anywhere else on that page.  I just
> found one in auto-explain.sgml, which I changed.

That's one of these I am not sure about.

> -    than 16KB; <function>gss_wrap_size_limit()</function> should be used by the
> +    than 16kB; <function>gss_wrap_size_limit()</function> should be used by the
> 
> Every other use in documentation has a lowercase "kay", and PG itself doesn't
> accept "KB" unit suffix.

Right.  There are more places like that, particularly in the comments
of the code.

> -     A few features included in the C99 standard are, at this time, not be
> +     A few features included in the C99 standard are, at this time, not
>       permitted to be used in core <productname>PostgreSQL</productname>
> 
> Indisputably wrong ?

Yep, this one is wrong as-is.
--
Michael

Commits

  1. Improve code inferring length of bitmap for JITed tuple deforming.

  2. Fix more typos and inconsistencies in documentation

  3. Fix collection of typos and grammar mistakes in docs and comments

  4. Clean up some documentation for log_statement_sample_rate