pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
pgsql: doc: Simplify description of functions for pg_walinspect
2+ messages / 1 participants
[nested] [flat]

* pgsql: doc: Simplify description of functions for pg_walinspect
@ 2023-01-13 00:30 Michael Paquier <michael@paquier.xyz>
  0 siblings, 0 replies; 2+ messages in thread

From: Michael Paquier @ 2023-01-13 00:30 UTC (permalink / raw)
  To: pgsql-committers@lists.postgresql.org

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(-)



^ permalink  raw  reply  [nested|flat] 2+ messages in thread

* pgsql: doc: Simplify description of functions for pg_walinspect
@ 2023-01-13 00:30 Michael Paquier <michael@paquier.xyz>
  0 siblings, 0 replies; 2+ messages in thread

From: Michael Paquier @ 2023-01-13 00:30 UTC (permalink / raw)
  To: pgsql-committers@lists.postgresql.org

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
------
REL_15_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/93595ffd5964247198699339fd8af19c1e4b6a33

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



^ permalink  raw  reply  [nested|flat] 2+ messages in thread


end of thread, other threads:[~2023-01-13 00:30 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-01-13 00:30 pgsql: doc: Simplify description of functions for pg_walinspect Michael Paquier <michael@paquier.xyz>
2023-01-13 00:30 pgsql: doc: Simplify description of functions for pg_walinspect Michael Paquier <michael@paquier.xyz>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox