66.6. Database Page Layout

Started by PG Bug reporting form8 days ago6 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/18/storage-page-layout.html
Description:

The second field contains the page checksum if -k are enabled.

-k -- This is enabled by default; use --no-data-checksums to disable
checksums.

Why does this need to be clarified?

#2Daniel Gustafsson
daniel@yesql.se
In reply to: PG Bug reporting form (#1)
Re: 66.6. Database Page Layout

On 8 Jul 2026, at 12:43, PG Doc comments form <noreply@postgresql.org> wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/18/storage-page-layout.html
Description:

The second field contains the page checksum if -k are enabled.

-k -- This is enabled by default; use --no-data-checksums to disable
checksums.

Why does this need to be clarified?

I'm not entirely sure which part you are referring to, but I agree that the
current wording isn't very good.

"The second field contains the page checksum if -k are enabled."

I propose the attached patch which changes the sentence to "The second field
contains the page checksum if data checksums are enabled." with a link to the
Checksums chapter in the documentation instead.

--
Daniel Gustafsson

Attachments:

page_layout_checksums.diffapplication/octet-stream; name=page_layout_checksums.diff; x-unix-mode=0644Download+1-1
#3Laurenz Albe
laurenz.albe@cybertec.at
In reply to: Daniel Gustafsson (#2)
Re: 66.6. Database Page Layout

On Thu, 2026-07-09 at 23:58 +0200, Daniel Gustafsson wrote:

I propose the attached patch which changes the sentence to "The second field
contains the page checksum if data checksums are enabled." with a link to the
Checksums chapter in the documentation instead.

That patch looks good to me.

Yours,
Laurenz Albe

#4Daniel Gustafsson
daniel@yesql.se
In reply to: Laurenz Albe (#3)
Re: 66.6. Database Page Layout

On 10 Jul 2026, at 08:33, Laurenz Albe <laurenz.albe@cybertec.at> wrote:

On Thu, 2026-07-09 at 23:58 +0200, Daniel Gustafsson wrote:

I propose the attached patch which changes the sentence to "The second field
contains the page checksum if data checksums are enabled." with a link to the
Checksums chapter in the documentation instead.

That patch looks good to me.

I took another look at this today to close the thread and found that there were
one more occurrence of this pattern stemming from 67846550dc6d which removed
the initdb xreflabels. The attached patches fix the other one as well as
changes the link in the amcheck docs to point to the main checksums page which
is more relevant than the (now default) initdb option. Patches for master down
to v18 attached.

--
Daniel Gustafsson

Attachments:

vmaster-0001-doc-Fix-link-text-for-data-checksums.patchapplication/octet-stream; name=vmaster-0001-doc-Fix-link-text-for-data-checksums.patch; x-unix-mode=0644Download+4-6
v18-0001-doc-Fix-link-text-for-data-checksums.patchapplication/octet-stream; name=v18-0001-doc-Fix-link-text-for-data-checksums.patch; x-unix-mode=0644Download+4-6
v19-0001-doc-Fix-link-text-for-data-checksums.patchapplication/octet-stream; name=v19-0001-doc-Fix-link-text-for-data-checksums.patch; x-unix-mode=0644Download+4-6
#5Laurenz Albe
laurenz.albe@cybertec.at
In reply to: Daniel Gustafsson (#4)
Re: 66.6. Database Page Layout

On Wed, 2026-07-15 at 15:17 +0200, Daniel Gustafsson wrote:

I took another look at this today to close the thread and found that there were
one more occurrence of this pattern stemming from 67846550dc6d which removed
the initdb xreflabels.  The attached patches fix the other one as well as
changes the link in the amcheck docs to point to the main checksums page which
is more relevant than the (now default) initdb option.  Patches for master down
to v18 attached.

Referencing "checksums" rather than "app-initdb-data-checksums" is an improvement
in all these places, and the only other reference to "app-initdb-data-checksums"
in the documentation is good the way it is and should stay.

So the patches look good to me.

Yours,
Laurenz Albe

#6Daniel Gustafsson
daniel@yesql.se
In reply to: Laurenz Albe (#5)
Re: 66.6. Database Page Layout

On 15 Jul 2026, at 16:50, Laurenz Albe <laurenz.albe@cybertec.at> wrote:

On Wed, 2026-07-15 at 15:17 +0200, Daniel Gustafsson wrote:

I took another look at this today to close the thread and found that there were
one more occurrence of this pattern stemming from 67846550dc6d which removed
the initdb xreflabels. The attached patches fix the other one as well as
changes the link in the amcheck docs to point to the main checksums page which
is more relevant than the (now default) initdb option. Patches for master down
to v18 attached.

Referencing "checksums" rather than "app-initdb-data-checksums" is an improvement
in all these places, and the only other reference to "app-initdb-data-checksums"
in the documentation is good the way it is and should stay.

So the patches look good to me.

Thanks for review!

--
Daniel Gustafsson