RE: index items for pg_stat_progress_xxx views

From: <Shinya11(dot)Kato(at)nttdata(dot)com>
To: <masao(dot)fujii(at)oss(dot)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 04:26:46
Message-ID: 6168075bd02a4ef18ed75153ad2a85f0@MP-MSGSS-MBX001.msg.nttdata.co.jp
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

>>> 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.

Regards,
Shinya Kato

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Fujii Masao 2020-12-01 05:06:13 Re: index items for pg_stat_progress_xxx views
Previous Message David G. Johnston 2020-11-30 20:25:58 Re: Change JOIN tutorial to focus more on explicit joins