Re: index items for pg_stat_progress_xxx views
Fujii Masao <masao.fujii@oss.nttdata.com>
From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Shinya11.Kato@nttdata.com, pgsql-docs@lists.postgresql.org
Date: 2020-12-01T08:21:15Z
Lists: pgsql-docs
On 2020/12/01 14:14, 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? > > 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
Commits
-
doc: Add additional index entries for progress reporting views.
- 0a4db67b5ed0 14.0 landed