Re: TLS docs fixes for <programlisting>

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: TLS docs fixes for <programlisting>
Date: 2020-05-14 07:38:09
Message-ID: 928D3FE2-7DB9-4AA9-9AAD-5CD1F09448EF@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 14 May 2020, at 04:17, Michael Paquier <michael(at)paquier(dot)xyz> wrote:
>
> On Wed, May 13, 2020 at 11:07:44PM +0200, Daniel Gustafsson wrote:
>> While working with TLS I noticed that the password callback definition had an
>> extra newline in the programlisting in the docs. Since the <programlisting>
>> has been indented with the textblock, the newline comes from whitespace being
>> significant. The attached 0001 fixes by instead anchoring <programlisting> on
>> column zero like how most of the docs do it. Grepping around I found one more
>> instance of the same pattern which is also included.
>
> Indeed, I can see the difference. In what I spotted after applying
> 0001, you are patching the one in libpq.sgml as of 0002 but in a
> different, correct, way, and I have spotted three more inconsistencies
> within doc/src/sgml/datatype.sgml in the zone for timestamps.

Right, I omitted them to avoid churn since they are using <programlisting>
correctly, just in a different way from the rest of the docs. I'll leave the
call whether they should be included for consistency sake to you.

> With everything I found on top of your stuff, I finish with the
> attached. Does it look fine to you?

+1, thanks for picking it up!

cheers ./daniel

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2020-05-14 09:06:34 CHECK constraints - order of evaluation
Previous Message Jean-Louis GUENEGO 2020-05-14 07:19:04 Re: dot dot dot dot