Questionable tag usage

From: Tatsuo Ishii <ishii(at)sraoss(dot)co(dot)jp>
To: pgsql-docs(at)postgresql(dot)org
Cc: pgsql-hackrs(at)postgresql(dot)org
Subject: Questionable tag usage
Date: 2017-01-04 23:40:28
Message-ID: 20170105.084028.597689697549228909.t-ishii@sraoss.co.jp
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

Attachment Content-Type Size
config.diff text/x-patch 768 bytes

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tatsuo Ishii 2017-01-05 00:25:57 Questionable tag usage
Previous Message Michael Paquier 2017-01-03 12:47:37 Re: gen_random_uuid security not explicit in documentation