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 1kjxrq-0004Gd-5k
	for pgsql-docs@arkaria.postgresql.org; Tue, 01 Dec 2020 05:06:22 +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 1kjxro-0003uN-FN
	for pgsql-docs@arkaria.postgresql.org; Tue, 01 Dec 2020 05:06:20 +0000
Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29])
	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 1kjxro-0003uF-9S
	for pgsql-docs@lists.postgresql.org; Tue, 01 Dec 2020 05:06:20 +0000
Received: from oss.nttdata.com ([49.212.34.109])
	by magus.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <masao.fujii@oss.nttdata.com>)
	id 1kjxrl-0002TR-Up
	for pgsql-docs@lists.postgresql.org; Tue, 01 Dec 2020 05:06:19 +0000
Received: from hnk.local (p1295030-ipngn4902funabasi.chiba.ocn.ne.jp
 [153.166.85.30])
	by oss.nttdata.com (Postfix) with ESMTPSA id 3642E622EA;
	Tue,  1 Dec 2020 14:06:14 +0900 (JST)
X-Virus-Status: Clean
X-Virus-Scanned: clamav-milter 0.102.3 at oss.nttdata.com
Subject: Re: index items for pg_stat_progress_xxx views
To: Shinya11.Kato@nttdata.com, pgsql-docs@lists.postgresql.org
References: <e49c2768-65d2-188a-5424-270fa29ccc84@oss.nttdata.com>
 <1ab4b582811046199a3de43f52d49b4f@MP-MSGSS-MBX001.msg.nttdata.co.jp>
 <5ec0801a-ed9b-630c-cad7-513049b708a3@oss.nttdata.com>
 <6168075bd02a4ef18ed75153ad2a85f0@MP-MSGSS-MBX001.msg.nttdata.co.jp>
From: Fujii Masao <masao.fujii@oss.nttdata.com>
Message-ID: <058732ef-03c1-5d30-c955-27dd43914a76@oss.nttdata.com>
Date: Tue, 1 Dec 2020 14:06:13 +0900
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:78.0)
 Gecko/20100101 Thunderbird/78.5.0
MIME-Version: 1.0
In-Reply-To: 
 <6168075bd02a4ef18ed75153ad2a85f0@MP-MSGSS-MBX001.msg.nttdata.co.jp>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
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/12/01 13:26, Shinya11.Kato@nttdata.com wrote:
>>>> Hi,
>>>>
>>>> The index items for pg_stat_progress_xxx views point to the "Viewing
>>>> Statistics" section, but not to the dedicated section (e.g., "ANALYZE
>>>> Progress
>>>> Reporting") for each view. IMO this is very inconvenient when finding
>>>> the section describing each pg_stat_progress_xxx view, from the index.
>>>> So what about adding new pointer to the section for each view in the index?
>>>> Patch attached.
>>>>
>>>> BTW, other stats views have both pointers in the index.
>>>
>>> When setting an <indexterm>, it's better to set the zone attribute to indicate
>> which section it's associated with.
>>>
>>> For example,
>>>    <indexterm zone="analyze-progress-reporting">
>>>      <primary>pg_stat_progress_analyze</primary>
>>>    </indexterm>
>>
>> Thanks for the review!
>>
>> I was thinking that the zone attribute doesn't need to be specified because the
>> indexterm is defined under the section that the indexterm tries to point to. You
>> can see the same situation at, for example, the section and indexterm of
>> pg_stat_database. If I'm missing something, could you tell me why the zone
>> attribute is necessary in this case?
> 
> I looked at lines 132-137 of monitoring.sgml, and I saw that zone is set for indexterm after <sect1>.
> However, I haven't found the zone set for indexterm after <sect2>, so you may be right.

So you agree not to add zone attribute in this case?

Regards,

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