SSL/TLS instead of SSL in docs

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Bruce Momjian <bruce(at)momjian(dot)us>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Magnus Hagander <magnus(at)hagander(dot)net>, Andrew Dunstan <andrew(dot)dunstan(at)2ndquadrant(dot)com>, Jeff Davis <pgsql(at)j-davis(dot)com>
Cc: PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: SSL/TLS instead of SSL in docs
Date: 2021-06-15 13:59:18
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

In the NSS thread it was discussed (20210603210642(dot)GF22012(at)momjian(dot)us etc) that
we use SSL rather than TLS in the documentation, which is technically somewhat
incorrect. Consensus came to using SSL/TLS instead for referring to encrypted
connections. Since this isn't really limited to the NSS work, I'm breaking
this out into a new thread.

Looking at the docs it turns out that we have a mix of SSL (with one ssl),
SSL/TLS and TLS for referring to the same thing. The attached changes the
documentation to consistently use SSL/TLS when referring to an encrypted
connection using a TLS protocol, leaving bare SSL and TLS only for referring to
the actual protocols. I *think* I found all instances, there are many so I
might have missed some, but this version seemed like a good place to continue
the discussion from the previous thread.

Admittedly it gets pretty unwieldy with the <acronym /> markup on SSL and TLS
but I opted for being consistent, since I don't know of any rules for when it
can/should be omitted (and it seems quite arbitrary right now). Mentions in
titles were previously not marked up so I've left those as is. I've also left
line breaks as an excercise for later to make the diff more readable.

While in there I added IMO missing items to the glossary and acronyms sections
as well as fixed up markup around OpenSSL.

This only deals with docs, but if this is deemed interesting then userfacing
messages in the code should use SSL/TLS as well of course.


Daniel Gustafsson

Attachment Content-Type Size
v1-0003-docs-Consistent-OpenSSL-markup.patch application/octet-stream 3.3 KB
v1-0002-docs-Replace-usage-of-SSL-with-SSL-TLS.patch application/octet-stream 73.0 KB
v1-0001-docs-SSL-TLS-related-acronyms-and-glossary.patch application/octet-stream 3.4 KB


Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2021-06-15 14:00:49 Re: [bug?] Missed parallel safety checks, and wrong parallel safety
Previous Message Tom Lane 2021-06-15 13:49:24 Re: unnesting multirange data types