Re: DOCS: Make the Server Application docs synopses more consistent

From: Peter Smith <smithpb2250(at)gmail(dot)com>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS: Make the Server Application docs synopses more consistent
Date: 2025-04-22 03:52:41
Message-ID: CAHut+Pv_hArN-xGu3tpw507=pZnYU2LktpD=C7vPkQxQ7Afs6w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

My previous v2 patch needed a rebase anyway, so I've taken this
opportunity also to restructure everything. Although it would be
easier to post a single patch, some of the changes are still
debatable. For this reason, now I've split the previous v2 patch into
multiple parts, hoping that it will help all the uncontroversial
changes to be easily committed up-front, so that we can focus any
debate on whatever remains.

Please find the v3 patches attached:
v3-0001 - Refer consistently to the --pgdata directory as 'datadir'
(most commands already do this, but not all).
v3-0002 - pg_walsummary. Fix typo. "with" should be "within"
v3-0003 - pg_walsummary. Change 'file' to 'filename' and add the
missing option description for it.
v3-0004 - pg_waldump. Some <option> tags are wrong; they should be <replaceable>
v3-0005 - [option] should be [option...] and make it always first,
like 95% of all commands already do.
v3-0006 - pg_controldata should have an "Options" section with
descriptions for -D and -V, and -? options.
v3-0007 - docguide. Added some new style guidelines for the reference
page synopsis

There are still several previously discussed (earlier in this thread)
changes that are not in this v3* patch set. They haven't been
forgotten; I'll revisit those later after the above (simpler) changes
are dealt with.

======
Kind Regards,
Peter Smith.
Fujitsu Australia

Attachment Content-Type Size
v3-0004-DOCS-pg_waldump.-Some-option-tags-are-wrong-shoul.patch application/octet-stream 1.0 KB
v3-0003-DOCS-pg_walsummary.-Change-file-to-filename-and-a.patch application/octet-stream 1.4 KB
v3-0001-DOCS-synopsis.-Refer-consistently-to-the-pgdata-d.patch application/octet-stream 4.8 KB
v3-0002-DOCS-pg_walsummary.-Fix-typo.-with-should-be-with.patch application/octet-stream 1.0 KB
v3-0005-DOCS-option-should-be-option.-and-make-it-always-.patch application/octet-stream 2.7 KB
v3-0007-DOCS-docguide.-Added-some-new-style-guidelines-fo.patch application/octet-stream 1.2 KB
v3-0006-DOCS-pg_controldata-should-have-Option-section-wi.patch application/octet-stream 2.4 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Zhijie Hou (Fujitsu) 2025-04-22 04:00:01 RE: Fix slot synchronization with two_phase decoding enabled
Previous Message Ashutosh Bapat 2025-04-22 03:45:43 Re: bug: virtual generated column can be partition key