doc: Fix initdb option xreflabels
authorPeter Eisentraut <[email protected]>
Wed, 16 Oct 2024 06:28:12 +0000 (08:28 +0200)
committerPeter Eisentraut <[email protected]>
Wed, 16 Oct 2024 06:28:12 +0000 (08:28 +0200)
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  revealed.

To fix, remove the two xreflabels and rewrite the link in config.sgml
with an explicit link text.

doc/src/sgml/config.sgml
doc/src/sgml/ref/initdb.sgml

index 9707d5238daa85d41344636bc4c39f30f07e46eb..934ef5e46910ecdcde632f9426e913d6e7e033ea 100644 (file)
@@ -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>
index a0ce261999943baf97c7b80e16cac061c834ebdf..b8207438910ae060f90132ef8448975ef899cd79 100644 (file)
@@ -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>