Re: index items for pg_stat_progress_xxx views

From: Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)com>
To: Shinya11(dot)Kato(at)nttdata(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: index items for pg_stat_progress_xxx views
Date: 2020-12-01 08:21:15
Message-ID: ab408f83-0b78-a6a0-54f6-5633d8b12549@oss.nttdata.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 2020/12/01 14:14, Shinya11(dot)Kato(at)nttdata(dot)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?
>
> Yes, I think it's nice.

So I pushed the patch. Thanks!

Regards,

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

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Jürgen Purtz 2020-12-01 08:38:20 Re: Change JOIN tutorial to focus more on explicit joins
Previous Message Shinya11.Kato 2020-12-01 05:14:29 RE: index items for pg_stat_progress_xxx views