[PATCH] doc: Clarify pg_checksums --filenode mode restriction

Started by R Sri Vishnu24 days ago4 messageshackers
Jump to latest
#1R Sri Vishnu
sri207881@gmail.com

Hi,

The pg_checksums reference page describes --filenode without stating that
it is only available in check mode. The command rejects it with --enable
or --disable, so a reader cannot use this option to limit those operations
to a single relation.

The attached PostgreSQL documentation patch adds that restriction to the
option description. It is against master at c11eb5de01b and is intended
for review and application. It changes no program behavior and has no
performance or platform-specific effects.

Validation: git diff --check, XML well-formedness of the changed reference
page, and DocBook XML 4.5 DTD validation of the changed paragraph passed.
The page contains no tabs or non-breaking spaces. The existing tests in
src/bin/pg_checksums/t/002_actions.pl cover both rejected combinations.
Those TAP tests and the full build/documentation build were not run.

This patch and submission note were prepared with OpenAI Codex assistance.

Thanks,
Sri Vishnu

#2Daniel Gustafsson
daniel@yesql.se
In reply to: R Sri Vishnu (#1)
Re: [PATCH] doc: Clarify pg_checksums --filenode mode restriction

On 29 Oct 2026, at 15:30, R Sri Vishnu <sri207881@gmail.com> wrote:

The attached PostgreSQL documentation patch

There is no patch attached.

--
Daniel Gustafsson

#3R Sri Vishnu
sri207881@gmail.com
In reply to: Daniel Gustafsson (#2)
Re: [PATCH] doc: Clarify pg_checksums --filenode mode restriction

Daniel, thanks for catching that. The previous message omitted the
patch. I have attached the complete v2 git-format patch to this reply.

The pg_checksums reference page now states that --filenode can only be
used with --check, matching the existing command-line validation. This
is a documentation-only change against current master. git diff
--check passes; I did not run the TAP suite for this revision.

Regards,
Sri Vishnu

Show quoted text

On Sun, Nov 1, 2026 at 2:55 AM Daniel Gustafsson <daniel@yesql.se> wrote:

On 29 Oct 2026, at 15:30, R Sri Vishnu <sri207881@gmail.com> wrote:

The attached PostgreSQL documentation patch

There is no patch attached.

--
Daniel Gustafsson

Attachments:

t254488_3
v2-0001-doc-clarify-pg_checksums-filenode-requires-check-.patchapplication/octet-stream; name=v2-0001-doc-clarify-pg_checksums-filenode-requires-check-.patchDownload+2-2
#4Daniel Gustafsson
daniel@yesql.se
In reply to: R Sri Vishnu (#3)
Re: [PATCH] doc: Clarify pg_checksums --filenode mode restriction

On 2 Nov 2026, at 16:07, R Sri Vishnu <sri207881@gmail.com> wrote:

Daniel, thanks for catching that. The previous message omitted the
patch. I have attached the complete v2 git-format patch to this reply.

Thanks, pushed with minor wordsmithing.

I did not run the TAP suite for this revision.

As this is a documentation change there is clearly no need, but running "ninja
docs" in a Meson buildtree would very much help a committer.

--
Daniel Gustafsson