[DOCS] Questionable tag usage - Mailing list pgsql-docs

From Tatsuo Ishii
Subject [DOCS] Questionable tag usage
Date
Msg-id 20170105.084028.597689697549228909.t-ishii@sraoss.co.jp
Whole thread Raw
Responses Re: [DOCS] Questionable tag usage  (Jürgen Purtz <juergen@purtz.de>)
List pgsql-docs
In:
https://www.postgresql.org/docs/devel/static/runtime-config-file-locations.html

---------------------------------------------------
ident_file (string)

    Specifies the configuration file for Section 20.2, “User Name Maps” user name mapping (customarily called
pg_ident.conf).This parameter can only be set at server start. 
---------------------------------------------------

"Specifies the configuration file for Section 20.2, “User Name Maps”
user name mapping" looks pretty strange to me because a raw section
name appears. This is due to the corresponding SGML coding:

       <para>
         Specifies the configuration file for
         <xref linkend="auth-username-maps"> user name mapping
         (customarily called <filename>pg_ident.conf</>).
         This parameter can only be set at server start.
       </para>

Shouldn't we use a link tag instead of the xref tag here? Attached is
a patch to fix this.

Best regards,
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese:http://www.sraoss.co.jp
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 30dd54c..1707d40 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -532,10 +532,10 @@ include_dir 'conf.d'
       </term>
       <listitem>
        <para>
-         Specifies the configuration file for
-         <xref linkend="auth-username-maps"> user name mapping
-         (customarily called <filename>pg_ident.conf</>).
-         This parameter can only be set at server start.
+         Specifies the configuration file
+         for <link linkend="auth-username-maps">user name mapping</link>
+         (customarily called <filename>pg_ident.conf</>).  This parameter can
+         only be set at server start.
        </para>
       </listitem>
      </varlistentry>

pgsql-docs by date:

Previous
From: Michael Paquier
Date:
Subject: Re: [DOCS] gen_random_uuid security not explicit in documentation
Next
From: Tatsuo Ishii
Date:
Subject: [DOCS] Questionable tag usage