doc: index items for pg_stat_progress_xxx views

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

doc: index items for pg_stat_progress_xxx views

Fujii Masao-4
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.

Regards,

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

indexterms_for_pg_stat_progress_xxx.patch (2K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

RE: index items for pg_stat_progress_xxx views

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

Regards,
Shinya Kato
Reply | Threaded
Open this post in threaded view
|

Re: index items for pg_stat_progress_xxx views

Fujii Masao-4


On 2020/11/30 10:57, [hidden email] 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


Reply | Threaded
Open this post in threaded view
|

Re: doc: index items for pg_stat_progress_xxx views

Michael Paquier-2
In reply to this post by Fujii Masao-4
On Thu, Nov 12, 2020 at 05:05:10PM +0900, Fujii Masao wrote:
> 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.

+1.
--
Michael

signature.asc (849 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

RE: index items for pg_stat_progress_xxx views

Shinya11.Kato
In reply to this post by Fujii Masao-4
>>> 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


Reply | Threaded
Open this post in threaded view
|

Re: index items for pg_stat_progress_xxx views

Fujii Masao-4


On 2020/12/01 13:26, [hidden email] 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


Reply | Threaded
Open this post in threaded view
|

RE: index items for pg_stat_progress_xxx views

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

Regards,
Shinya Kato
Reply | Threaded
Open this post in threaded view
|

Re: index items for pg_stat_progress_xxx views

Fujii Masao-4


On 2020/12/01 14:14, [hidden email] 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