pgsql: doc: Simplify description of functions for pg_walinspect

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Simplify description of functions for pg_walinspect
Date: 2023-01-13 00:30:36
Message-ID: E1pG7xs-003NOn-CV@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Simplify description of functions for pg_walinspect

As introduced in 2258e76, the docs were hard to parse:
- The examples used listed a lot of long records, bloating the output.
These are switched to show less records with the expanded format,
similarly to pageinspect.
- The function descriptions listed all the OUT parameters, producing
long lines. This is updated so as only the input parameters are
documented, clarifying the whole.
- Remove one example on pg_get_wal_stats() when per_record is set to
true, which is not really necessary once we know the output produced,
and the behavior of the parameter is documented.

While on it, fix a few grammar mistakes and simplify a couple of
sentences.

Author: Bharath Rupireddy
Discussion: https://postgr.es/m/CALj2ACVGcUpziGgQrcT-1G3dHWQQfWjYBu1YQ2ypv9y86dgogg@mail.gmail.com
Backpatch-through: 15

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/58597edea102258b21d5f4b4f0d7796c0ebf100a

Modified Files
--------------
doc/src/sgml/pgwalinspect.sgml | 181 ++++++++++++-----------------------------
1 file changed, 54 insertions(+), 127 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message David G. Johnston 2023-01-13 01:15:50 Re: pgsql: Add new GUC createrole_self_grant.
Previous Message Thomas Munro 2023-01-12 22:06:39 pgsql: Fix WaitEventSetWait() buffer overrun.