TLS docs fixes for <programlisting>

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: pgsql-docs(at)postgresql(dot)org
Subject: TLS docs fixes for <programlisting>
Date: 2020-05-13 21:07:44
Message-ID: 401F9024-20EA-4239-83C4-6B7AD35F94BD@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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.

The "Enter PEM pass phrase" prompt was referred to in one place with <literal>
and one with <programlisting>, the 0002 settles on using <literal> for both
since IMO that makes the docs more readable. While there, it also fixes the
spelling of "pass phrase" from the two variations we had (of which none was the
correct one from src/backend/libpq/be-secure-openssl.c as well as the OpenSSL
file crypto/pem/pem_lib.c).

cheers ./daniel

Attachment Content-Type Size
0002-doc-fix-PEM-prompt-markup.patch application/octet-stream 1.9 KB
0001-doc-anchor-programlisting-on-column-zero.patch application/octet-stream 2.2 KB

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Michael Paquier 2020-05-14 00:07:38 Re: Missing comma?
Previous Message Jürgen Purtz 2020-05-13 19:19:08 Re: dot dot dot dot