Questionable tag usage

Started by Tatsuo Ishiiover 9 years ago4 messagesdocs
Beta feature

Hackorum builds and tests every patch posted to the lists, not only commitfest submissions. This is Hackorum's own CI rather than the PostgreSQL project's, and it is still under testing - please report anything that looks wrong.

won't retrysuccessCI history

You can run a PostgreSQL built from this patch straight from Docker, with no checkout and no build:

docker run --rm -p 5432:5432 ghcr.io/hackorum-dev/postgres-patch:t75856
psql -h localhost -U postgres

Built from patchset v1 (message #1), July 28, 2026 at 08:45 AM.

Every patchset is also pushed to a branch of our PostgreSQL fork, so you can check out the same tree CI built. Without a PostgreSQL checkout:

git clone --branch t75856_1 https://github.com/hackorum-dev/postgres.git

In a checkout you already have, add the fork once:

git remote add hackorum https://github.com/hackorum-dev/postgres.git

then, for this patchset and every later one:

git fetch hackorum t75856_1 && git checkout t75856_1

Patchset v1 (message #1) is on t75856_1

Jump to latest
#1Tatsuo Ishii
ishii@postgresql.org

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

Attachments:

t75856_1
config.difftext/x-patch; charset=us-asciiDownload+4-4
#2Jürgen Purtz
juergen@purtz.de
In reply to: Tatsuo Ishii (#1)
Re: Questionable tag usage

Some general notes to the discussion about <xref> vs. <link> rendering
in the new toolchain:

(1) There is a general distinction in the *meaning* of the two elements:
<xref> is an internal link with validation semantic whereas <link> is an
external link to any URL. See:
http://doccookbook.sourceforge.net/html/en/dbc.markup.xref-vs-link.html

(2) The *rendering* of <xref> can be customized via its
xrefstyle-attribute. It switches numbering, title, page number, ... on
or off, see:
http://doccookbook.sourceforge.net/html/en/dbc.markup.xref.html#sec.markup.xref.xrefstyle
. This feature is available per element usage or as a default behaviour,
which is defined in the language file of the xslt process (eg: en.xml).

(3) The option to render the xref-output as described in (2) is
available since docbook 4.3. Unfortunately we use docbook 4.2. To
overcome this shortage we can use the following - more or less
cumbersome - workaround:
http://www.sagehill.net/docbookxsl/CustomXrefs.html#RoleNotXrefstyle and
http://www.sagehill.net/docbookxsl/CustomGentext.html .

Kind regards, J�rgen Purtz

Show quoted text

On 05.01.2017 00:40, Tatsuo Ishii wrote:

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

#3Robert Haas
robertmhaas@gmail.com
In reply to: Jürgen Purtz (#2)
Re: Questionable tag usage

On Wed, Jan 11, 2017 at 3:46 AM, Jürgen Purtz <juergen@purtz.de> wrote:

(1) There is a general distinction in the meaning of the two elements:
<xref> is an internal link with validation semantic whereas <link> is an
external link to any URL. See:
http://doccookbook.sourceforge.net/html/en/dbc.markup.xref-vs-link.html

Eh, we use both <link> and <xref> for internal links and surely want
both to be validated. If that's no longer happening I don't think it
will be long before it bites us.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Robert Haas (#3)
Re: Questionable tag usage

Robert Haas <robertmhaas@gmail.com> writes:

On Wed, Jan 11, 2017 at 3:46 AM, Jürgen Purtz <juergen@purtz.de> wrote:

(1) There is a general distinction in the meaning of the two elements:
<xref> is an internal link with validation semantic whereas <link> is an
external link to any URL. See:
http://doccookbook.sourceforge.net/html/en/dbc.markup.xref-vs-link.html

Eh, we use both <link> and <xref> for internal links and surely want
both to be validated. If that's no longer happening I don't think it
will be long before it bites us.

I think that is talking about something different, namely the difference
between linkend and href properties. linkend points to a tag in the
current document, and AFAIK it behaves the same in <link> or <xref>.
href is used for external links.

The author of the cited page may believe that <link linkend=...> is bad
style, but he doesn't say that in so many words, and even if he did
I'm not sure I would agree.

regards, tom lane

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs