public inbox for [email protected]  

help / color / mirror / Atom feed

DOCS: Update data_checksums documentation to reflect enum change
2+ messages / 2 participants
[nested] [flat]

* DOCS: Update data_checksums documentation to reflect enum change
@ 2026-04-08 06:38  Lakshmi N <[email protected]>
  0 siblings, 1 reply; 2+ messages in thread

From: Lakshmi N @ 2026-04-08 06:38 UTC (permalink / raw)
  To: pgsql-hackers; [email protected]

Hi hackers,

Following commit f19c0eccae9680f5785b11cdc58ef571998caec9, the
data_checksums configuration parameter type was changed from a boolean to
an enum. Attaching a small patch to reflect this change.

Regards,
Lakshmi


Attachments:

  [application/octet-stream] 0001-doc-Update-data_checksums-documentation-to-reflect-e.patch (1.7K, 3-0001-doc-Update-data_checksums-documentation-to-reflect-e.patch)
  download | inline diff:
From 7c237e58f59d0b9b926fd000ae98546a5849a228 Mon Sep 17 00:00:00 2001
From: Lakshmi N <[email protected]>
Date: Tue, 7 Apr 2026 23:17:17 -0700
Subject: [PATCH] doc: Update data_checksums documentation to reflect enum
 change

Following commit f19c0eccae9680f5785b11cdc58ef571998caec9, the data_checksums configuration parameter type was changed from a boolean to an enum. This updates the documentation to accurately reflect its new type and document the new possible states: 'on', 'off', 'inprogress-on', and 'inprogress-off'.
---
 doc/src/sgml/config.sgml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 2c4106ee9ab..bbbe8ea735f 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -12123,14 +12123,16 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir'
      </varlistentry>
 
      <varlistentry id="guc-data-checksums" xreflabel="data_checksums">
-      <term><varname>data_checksums</varname> (<type>boolean</type>)
+      <term><varname>data_checksums</varname> (<type>enum</type>)
       <indexterm>
        <primary><varname>data_checksums</varname> configuration parameter</primary>
       </indexterm>
       </term>
       <listitem>
        <para>
-        Reports whether data checksums are enabled for this cluster.
+        Reports the state of data checksums for this cluster.
+        Possible values are <literal>on</literal>, <literal>off</literal>,
+        <literal>inprogress-on</literal> and <literal>inprogress-off</literal>.
         See <xref linkend="app-initdb-data-checksums"/> for more information.
        </para>
       </listitem>
-- 
2.43.0



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

* Re: DOCS: Update data_checksums documentation to reflect enum change
@ 2026-04-08 20:03  Daniel Gustafsson <[email protected]>
  parent: Lakshmi N <[email protected]>
  0 siblings, 0 replies; 2+ messages in thread

From: Daniel Gustafsson @ 2026-04-08 20:03 UTC (permalink / raw)
  To: Lakshmi N <[email protected]>; +Cc: pgsql-hackers; [email protected]

> On 8 Apr 2026, at 09:38, Lakshmi N <[email protected]> wrote:

> Following commit f19c0eccae9680f5785b11cdc58ef571998caec9, the data_checksums configuration parameter type was changed from a boolean to an enum. Attaching a small patch to reflect this change.

Thanks for the patch, I added a small change to update the xref to point to the
main data checksums section and pushed it.

--
Daniel Gustafsson






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

end of thread, other threads:[~2026-04-08 20:03 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-04-08 06:38 DOCS: Update data_checksums documentation to reflect enum change Lakshmi N <[email protected]>
2026-04-08 20:03 ` Daniel Gustafsson <[email protected]>

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