Re: index items for pg_stat_progress_xxx views - Mailing list pgsql-docs

From Fujii Masao
Subject Re: index items for pg_stat_progress_xxx views
Date
Msg-id 5ec0801a-ed9b-630c-cad7-513049b708a3@oss.nttdata.com
Whole thread Raw
In response to RE: index items for pg_stat_progress_xxx views  (<Shinya11.Kato@nttdata.com>)
Responses RE: index items for pg_stat_progress_xxx views  (<Shinya11.Kato@nttdata.com>)
List pgsql-docs

On 2020/11/30 10:57, 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?

Regards,

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



pgsql-docs by date:

Previous
From:
Date:
Subject: RE: index items for pg_stat_progress_xxx views
Next
From: Michael Paquier
Date:
Subject: Re: doc: index items for pg_stat_progress_xxx views