pgsql: Revamp documentation for predefined roles.

From: Nathan Bossart <nathan(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Revamp documentation for predefined roles.
Date: 2024-07-10 21:38:06
Message-ID: E1sRf0o-001AKY-Ry@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Revamp documentation for predefined roles.

Presently, the page for predefined roles contains a table with
brief descriptions of what each role allows. Below the table,
there is a separate section with more detailed information about
some of the roles. As the set of predefined roles has grown over
the years, this page has (IMHO) become less readable.

This commit attempts to improve the predefined roles documentation
by abandoning the table in favor of listing each role with its own
complete description, similar to how we document GUCs. Besides
merging the information that was split between the table and the
section below it, this commit also alphabetizes the roles. The
alphabetization is imperfect because some of the roles are grouped
(e.g., pg_read_all_data and pg_write_all_data), and we order such
groups by the first role mentioned, but that seemed like a better
choice than breaking the groups apart. Finally, this commit makes
some stylistic adjustments to the text.

Reviewed-by: David G. Johnston, Robert Haas
Discussion: https://postgr.es/m/ZmtM-4-eRtq8DRf6%40nathan

Branch
------
master

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

Modified Files
--------------
doc/src/sgml/config.sgml | 2 +-
doc/src/sgml/monitoring.sgml | 4 +-
doc/src/sgml/ref/checkpoint.sgml | 2 +-
doc/src/sgml/ref/reindex.sgml | 2 +-
doc/src/sgml/user-manag.sgml | 355 +++++++++++++++++++++------------------
5 files changed, 197 insertions(+), 168 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Tom Lane 2024-07-11 00:16:11 pgsql: Make our back branches compatible with libxml2 2.13.x.
Previous Message Dean Rasheed 2024-07-10 19:09:36 pgsql: Improve the numeric width_bucket() computation.