From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
Date: Fri, 22 May 2020 22:35:09 +0900
Message-ID: <f5c9ace0-1691-06e7-7d36-4cebe9e64165@oss.nttdata.com> (raw)
In-Reply-To: <5996.1590004403@sss.pgh.pa.us>
References: <6f8a482c-b3fa-4ed9-21c3-6d222a2cb87d@oss.nttdata.com>
<23668.1589940341@sss.pgh.pa.us>
<f31875d6-2300-87af-1479-c9d9abc013be@oss.nttdata.com>
<19926.1589981558@sss.pgh.pa.us>
<bd73f8fe-7a9f-d903-b84f-8410ba3e1d5f@oss.nttdata.com>
<5996.1590004403@sss.pgh.pa.us>
On 2020/05/21 4:53, Tom Lane wrote:
> Fujii Masao <masao.fujii@oss.nttdata.com> writes:
>> On 2020/05/20 22:32, Tom Lane wrote:
>>> OK by me --- that, too, would be more like the existing catalogs
>>> chapter.
>
>> Yeah, so I'd like to propose the attached patch.
>
> Hmmm ... I'm not exactly convinced about sticking xreflabels onto
> the <sect2>s as you've done here. Presumably that would make <xref>s
> render like "pg_stat_slru" not "Section 27.2.3", which I think is
> not consistent with our practice elsewhere. I'd be inclined to
> leave the id attributes on the <table>s, and add xreflabels there
> if we want them.
>
> I see that catalogs.sgml doesn't really match either of those approaches,
> though. Not sure if we want to change it. It looks like people have
> tended to use <link> to substitute text for xref's to the catalog
> sections, so maybe it would be better to add xreflabels there too
> and simplify the references.
Yeah, since I think that using <xref> is simpler than <link>, I added xlabel
in <sect2>. But if we don't do that for the consistency with catalog.sgml,
I think that there are two approaches.
(1) Replace <xref> with <link> when referencing to the monitoring views
docs. For example, add <sect2 id="monitoring-pg-stat-relication-view">
and replace <xref linkend="pg-stat-replication-view"/> with
<link linkend="monitoring-pg-stat-replication-view">.
(2) Leave <xref> as it is. In this case, for example,
<xref linkend="pg-stat-replication-view"/> references to the table
of pg_stat_replication instead of the section.
I prefer (1) because it's better to reference to the section rather than
the table. There are thirty <xref> for monitoring views in the docs and
they need to be updated.
>
> Other than that markup quibble, this looks fine to me.
Thanks for the review!
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, tgl@sss.pgh.pa.us, pgsql-docs@lists.postgresql.org
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
In-Reply-To: <f5c9ace0-1691-06e7-7d36-4cebe9e64165@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox