pgsql: doc: Standardise cleartext and plain text terms

From: Daniel Gustafsson <dgustafsson(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Standardise cleartext and plain text terms
Date: 2026-11-20 09:23:44
Message-ID: E1xUKqN-00000000UmK-1EEg@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Standardise cleartext and plain text terms

Replace variations of "plain text", plaintext, plain-text, "clear text",
cleartext and clear-text with either "plain text" or cleartext depending
on context.

Use cleartext to refer to unencrypted data in storage or transmission.
Use cleartext instead of plaintext because it is consistent with the
AuthenticationCleartextPassword server message, it is the term most used
throughout the Postgres docs, and it is different enough from "plain text"
not to cause confusion.

Treat cleartext as a synonym for plaintext. Although not entirely accurate
from a cryptography point of view, where plaintext is defined as the input
to a data encryption algorithm or the output of a decryption process, the
terms are used synonymously in many places, and are likely to be understood
as synonyms by the majority of Postgres users.

Use "plain text" to refer to unformatted, human-readable text. This was
selected instead of the hyphenated plain-text because "plain text" is the
standard form across the majority of technical documentation. This is the
case even when it is used as an adjective, for example: "a plain text file".

Rewrite sentences that contain the construct "non-plain-text" in order to
remain consistent and avoid ambiguity.

Add glossary entries to define the terms used.

Author: Karen Jex <karenhjex(at)gmail(dot)com>
Reviewed-by: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
Reviewed-by: Xavier Fischer <xavier_fischer(at)hotmail(dot)fr>
Reviewed-by: Daniel Gustafsson <daniel(at)yesql(dot)se>
Reviewed-by: Peter Smith <smithpb2250(at)gmail(dot)com>
Discussion: https://postgr.es/m/D7B95A7B-88B8-43E6-9DFB-2261B0849337@yesql.se

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/afdbe2596ce4ac98207aabf10e873b5095d6b51a

Modified Files
--------------
doc/src/sgml/catalogs.sgml | 2 +-
doc/src/sgml/client-auth.sgml | 16 ++++++++--------
doc/src/sgml/config.sgml | 2 +-
doc/src/sgml/dblink.sgml | 4 ++--
doc/src/sgml/docguide.sgml | 2 +-
doc/src/sgml/func/func-trigger.sgml | 4 ++--
doc/src/sgml/glossary.sgml | 21 +++++++++++++++++++++
doc/src/sgml/libpq.sgml | 4 ++--
doc/src/sgml/maintenance.sgml | 2 +-
doc/src/sgml/passwordcheck.sgml | 2 +-
doc/src/sgml/pgcrypto.sgml | 8 ++++----
doc/src/sgml/postgres-fdw.sgml | 4 ++--
doc/src/sgml/protocol.sgml | 6 +++---
doc/src/sgml/ref/pg_dump.sgml | 9 +++++----
doc/src/sgml/ref/pg_restore.sgml | 7 ++++---
doc/src/sgml/ref/psql-ref.sgml | 4 ++--
16 files changed, 60 insertions(+), 37 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Eisentraut 2026-11-20 09:46:20 pgsql: Fix accidentally casting away const
Previous Message Fujii Masao 2026-11-20 06:22:27 pgsql: Fix parsing mode tracking when recycling datetime format cache e