postgres.git / summary / log / commit / refs

commit    67846550dc6d7d90db4d98cdd8a8440725ef5c65
Author:   Peter Eisentraut <peter@eisentraut.org>
Date:     Wed Oct 16 06:28:12 2024 +0000
First released in: 18.0

    doc: Fix initdb option xreflabels
    
    Generally, we don't want any overriding xreflabels in the options
    list, so that we can link to options and the link renders as the
    option name.  The -g option did this differently and config.sgml made
    use of that for a link.  The new --no-data-checksums option (commit
    983a588e0b8) apparently copied this pattern, but that seems like the
    wrong direction, as a future patch revealed.
    
    To fix, remove the two xreflabels and rewrite the link in config.sgml
    with an explicit link text.


 doc/src/sgml/config.sgml     | 4 +++-
 doc/src/sgml/ref/initdb.sgml | 4 ++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 9707d5238da..934ef5e4691 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -11042,7 +11042,9 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
         had at server startup.
         (On Microsoft Windows this parameter will always display
         <literal>0700</literal>.) See
-        <xref linkend="app-initdb-allow-group-access"/> for more information.
+        <link linkend="app-initdb-allow-group-access">the
+        <application>initdb</application> <option>-g</option> option</link>
+        for more information.
        </para>
       </listitem>
      </varlistentry>
diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml
index a0ce2619999..b8207438910 100644
--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
@@ -227,7 +227,7 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
-     <varlistentry id="app-initdb-allow-group-access" xreflabel="group access">
+     <varlistentry id="app-initdb-allow-group-access">
       <term><option>-g</option></term>
       <term><option>--allow-group-access</option></term>
       <listitem>
@@ -260,7 +260,7 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
-     <varlistentry id="app-initdb-data-checksums" xreflabel="data checksums">
+     <varlistentry id="app-initdb-data-checksums">
       <term><option>-k</option></term>
       <term><option>--data-checksums</option></term>
       <listitem>


[parent: d5ca15ee54bf]