SSL/TLS instead of SSL in docs
Daniel Gustafsson <daniel@yesql.se>
From: Daniel Gustafsson <daniel@yesql.se>
To: Bruce Momjian <bruce@momjian.us>,
Tom Lane <tgl@sss.pgh.pa.us>,
Magnus Hagander <magnus@hagander.net>,
Andrew Dunstan <andrew.dunstan@2ndquadrant.com>,
Jeff Davis <pgsql@j-davis.com>
Cc: PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2021-06-15T13:59:18Z
Lists: pgsql-hackers
Attachments
- v1-0003-docs-Consistent-OpenSSL-markup.patch (application/octet-stream) patch v1-0003
- v1-0002-docs-Replace-usage-of-SSL-with-SSL-TLS.patch (application/octet-stream) patch v1-0002
- v1-0001-docs-SSL-TLS-related-acronyms-and-glossary.patch (application/octet-stream) patch v1-0001
In the NSS thread it was discussed (20210603210642.GF22012@momjian.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. Thoughts? -- Daniel Gustafsson https://vmware.com/
Commits
-
doc: Clarify when SSL actually means TLS
- 860ea46ba7be 15.0 landed
-
doc: Add acronyms for MITM and SNI
- 15ff5401d171 14.0 landed
-
doc: Apply markup <productname> to OpenSSL more consistently
- f80979f659d3 14.0 landed
-
Introduce --with-ssl={openssl} as a configure option
- fe61df7f82aa 14.0 cited