postgres.git / summary / log / commit / refs

commit    b364828f825a5914a21140145186365021ac0bc4
Author:   Daniel Gustafsson <dgustafsson@postgresql.org>
Date:     Wed Apr 08 19:53:43 2026 +0000

    doc: Fix data_checksums data type
    
    Commit f19c0eccae96 changed the data_checksums GUC datatype 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'.
    
    Also update the xref for more information to point to the section
    on data checksums rather than the initdb checksum option.
    
    Author: Lakshmi N <lakshmin.jhs@gmail.com>
    Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
    Discussion: https://postgr.es/m/CA+3i_M-AtTnqTB2KLBTpu-c-jvnTuy7bGxyxs80rgiQLxWrRUQ@mail.gmail.com


 doc/src/sgml/config.sgml | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 1c8b8e7f3e2..009295f20e9 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -12182,15 +12182,17 @@ 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.
-        See <xref linkend="app-initdb-data-checksums"/> for more information.
+        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="checksums"/> for more information.
        </para>
       </listitem>
      </varlistentry>


[parent: e0851bded641]