Received: from malur.postgresql.org ([217.196.149.56])
	by arkaria.postgresql.org with esmtps
 (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <pgsql-docs-owner+archive@lists.postgresql.org>)
	id 1jdmZC-000293-On
	for pgsql-docs@arkaria.postgresql.org; Wed, 27 May 2020 03:17:18 +0000
Received: from localhost ([127.0.0.1] helo=malur.postgresql.org)
	by malur.postgresql.org with esmtp (Exim 4.92)
	(envelope-from <pgsql-docs-owner+archive@lists.postgresql.org>)
	id 1jdmZB-0001dA-Bi
	for pgsql-docs@arkaria.postgresql.org; Wed, 27 May 2020 03:17:17 +0000
Received: from makus.postgresql.org ([2001:4800:3e1:1::229])
	by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <masao.fujii@oss.nttdata.com>)
	id 1jdmZB-0001d2-5v
	for pgsql-docs@lists.postgresql.org; Wed, 27 May 2020 03:17:17 +0000
Received: from oss.nttdata.com ([49.212.34.109])
	by makus.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <masao.fujii@oss.nttdata.com>)
	id 1jdmZ8-0002v1-1k
	for pgsql-docs@lists.postgresql.org; Wed, 27 May 2020 03:17:16 +0000
Received: from hnk.local (p1864124-ipbf1405funabasi.chiba.ocn.ne.jp
 [123.216.143.124])
	by oss.nttdata.com (Postfix) with ESMTPSA id 618F5602BA;
	Wed, 27 May 2020 12:17:09 +0900 (JST)
X-Virus-Status: Clean
X-Virus-Scanned: clamav-milter 0.102.2 at oss.nttdata.com
Subject: Re: descriptions of pg_stat_user_functions and pg_stat_slru
From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: pgsql-docs@lists.postgresql.org
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>
 <f5c9ace0-1691-06e7-7d36-4cebe9e64165@oss.nttdata.com>
 <519b6526-18fb-3a36-7d1b-7d566f14e7f0@oss.nttdata.com>
Message-ID: <69bcd2af-0d28-de74-0f37-a9c9a4fcf471@oss.nttdata.com>
Date: Wed, 27 May 2020 12:17:08 +0900
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:68.0)
 Gecko/20100101 Thunderbird/68.8.0
MIME-Version: 1.0
In-Reply-To: <519b6526-18fb-3a36-7d1b-7d566f14e7f0@oss.nttdata.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 8bit
List-Id: <pgsql-docs.lists.postgresql.org>
List-Help: <https://lists.postgresql.org/manage/>
List-Subscribe: <https://lists.postgresql.org/manage/>
List-Post: <mailto:pgsql-docs@lists.postgresql.org>
List-Owner: <mailto:pgsql-docs-owner@lists.postgresql.org>
List-Archive: <https://www.postgresql.org/list/pgsql-docs>
Precedence: bulk



On 2020/05/25 14:23, Fujii Masao wrote:
> 
> 
> On 2020/05/22 22:35, Fujii Masao wrote:
>>
>>
>> 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.
> 
> Attached (monitoring_docfix_v2.patch) is the patch for (1).

Barring any objection, I will commit this patch.

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION