agora inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedMinor Improvements to pg_buffercache documentation
3+ messages / 3 participants
[nested] [flat]
* Minor Improvements to pg_buffercache documentation
@ 2025-07-02 16:30 Fujii Masao <masao.fujii@oss.nttdata.com>
2025-07-22 05:10 ` Re: Minor Improvements to pg_buffercache documentation Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 3+ messages in thread
From: Fujii Masao @ 2025-07-02 16:30 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
Hi,
While reading commit 8eede2c7200 and the pg_buffercache docs,
I noticed a few minor issues:
- There are missing index entries for pg_buffercache_numa() and
pg_buffercache_usage_counts(), even though other functions have them.
- The section titles for pg_buffercache_evict_relation and
pg_buffercache_evict_all are missing parentheses, unlike the others.
The attached patch addresses these points by:
- Adding index entries for pg_buffercache_numa() and
pg_buffercache_usage_counts().
- Making the function section titles consistent by including parentheses
where they were missing.
Also, a quick note on pg_buffercache_numa_pages(): although there's
an index entry for pg_buffercache_pages(), I didn't add one for
pg_buffercache_numa_pages() because both functions are typically accessed
via views, not directly. Regarding those functions, it seems enough to
have index entries for the views. So, it might make more sense to remove
the existing index entry for pg_buffercache_pages() for consistency.
BTW, all current index entries point to the top of the pg_buffercache
docs. Would it be better if each entry pointed directly to its relevant
section using a zone attribute like this?
- <indexterm>
+ <indexterm zone="pgbuffercache-summary">
<primary>pg_buffercache_summary</primary>
</indexterm>
Thought?
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
From 06013d1d1fbaa64aa99f5067b2608ab833a92b3d Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Thu, 3 Jul 2025 00:35:44 +0900
Subject: [PATCH v1] doc: Add missing index entries and fix title formatting in
pg_buffercache docs.
This commit adds missing index entries for the functions pg_buffercache_numa()
and pg_buffercache_usage_counts() in the pg_buffercache documentation.
It also makes the function titles consistent by adding parentheses after
function names where they were previously missing.
---
doc/src/sgml/pgbuffercache.sgml | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 546ace8369e..eeb85a0e049 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -19,10 +19,18 @@
<primary>pg_buffercache_pages</primary>
</indexterm>
+ <indexterm>
+ <primary>pg_buffercache_numa</primary>
+ </indexterm>
+
<indexterm>
<primary>pg_buffercache_summary</primary>
</indexterm>
+ <indexterm>
+ <primary>pg_buffercache_usage_counts</primary>
+ </indexterm>
+
<indexterm>
<primary>pg_buffercache_evict</primary>
</indexterm>
@@ -489,7 +497,7 @@
</sect2>
<sect2 id="pgbuffercache-pg-buffercache-evict-relation">
- <title>The <structname>pg_buffercache_evict_relation</structname> Function</title>
+ <title>The <structname>pg_buffercache_evict_relation()</structname> Function</title>
<para>
The <function>pg_buffercache_evict_relation()</function> function is very
similar to the <function>pg_buffercache_evict()</function> function. The
@@ -507,7 +515,7 @@
</sect2>
<sect2 id="pgbuffercache-pg-buffercache-evict-all">
- <title>The <structname>pg_buffercache_evict_all</structname> Function</title>
+ <title>The <structname>pg_buffercache_evict_all()</structname> Function</title>
<para>
The <function>pg_buffercache_evict_all()</function> function is very
similar to the <function>pg_buffercache_evict()</function> function. The
--
2.49.0
Attachments:
[text/plain] v1-0001-doc-Add-missing-index-entries-and-fix-title-forma.patch (2.0K, ../../7d19af4b-7da3-4862-9f52-ff958960bd8d@oss.nttdata.com/2-v1-0001-doc-Add-missing-index-entries-and-fix-title-forma.patch)
download | inline diff:
From 06013d1d1fbaa64aa99f5067b2608ab833a92b3d Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Thu, 3 Jul 2025 00:35:44 +0900
Subject: [PATCH v1] doc: Add missing index entries and fix title formatting in
pg_buffercache docs.
This commit adds missing index entries for the functions pg_buffercache_numa()
and pg_buffercache_usage_counts() in the pg_buffercache documentation.
It also makes the function titles consistent by adding parentheses after
function names where they were previously missing.
---
doc/src/sgml/pgbuffercache.sgml | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 546ace8369e..eeb85a0e049 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -19,10 +19,18 @@
<primary>pg_buffercache_pages</primary>
</indexterm>
+ <indexterm>
+ <primary>pg_buffercache_numa</primary>
+ </indexterm>
+
<indexterm>
<primary>pg_buffercache_summary</primary>
</indexterm>
+ <indexterm>
+ <primary>pg_buffercache_usage_counts</primary>
+ </indexterm>
+
<indexterm>
<primary>pg_buffercache_evict</primary>
</indexterm>
@@ -489,7 +497,7 @@
</sect2>
<sect2 id="pgbuffercache-pg-buffercache-evict-relation">
- <title>The <structname>pg_buffercache_evict_relation</structname> Function</title>
+ <title>The <structname>pg_buffercache_evict_relation()</structname> Function</title>
<para>
The <function>pg_buffercache_evict_relation()</function> function is very
similar to the <function>pg_buffercache_evict()</function> function. The
@@ -507,7 +515,7 @@
</sect2>
<sect2 id="pgbuffercache-pg-buffercache-evict-all">
- <title>The <structname>pg_buffercache_evict_all</structname> Function</title>
+ <title>The <structname>pg_buffercache_evict_all()</structname> Function</title>
<para>
The <function>pg_buffercache_evict_all()</function> function is very
similar to the <function>pg_buffercache_evict()</function> function. The
--
2.49.0
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Minor Improvements to pg_buffercache documentation
2025-07-02 16:30 Minor Improvements to pg_buffercache documentation Fujii Masao <masao.fujii@oss.nttdata.com>
@ 2025-07-22 05:10 ` Michael Paquier <michael@paquier.xyz>
2025-07-24 02:56 ` Re: Minor Improvements to pg_buffercache documentation Fujii Masao <masao.fujii@gmail.com>
0 siblings, 1 reply; 3+ messages in thread
From: Michael Paquier @ 2025-07-22 05:10 UTC (permalink / raw)
To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: pgsql-docs@lists.postgresql.org
On Thu, Jul 03, 2025 at 01:30:13AM +0900, Fujii Masao wrote:
> BTW, all current index entries point to the top of the pg_buffercache
> docs. Would it be better if each entry pointed directly to its relevant
> section using a zone attribute like this?
>
> - <indexterm>
> + <indexterm zone="pgbuffercache-summary">
> <primary>pg_buffercache_summary</primary>
> </indexterm>
That would be smarter than the current statu-quo of the page,
especially if this page grows more in size in the future.
The other inconsistencies are good catches, by the way!
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../aH8dSGJ_csT2XXAf@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Minor Improvements to pg_buffercache documentation
2025-07-02 16:30 Minor Improvements to pg_buffercache documentation Fujii Masao <masao.fujii@oss.nttdata.com>
2025-07-22 05:10 ` Re: Minor Improvements to pg_buffercache documentation Michael Paquier <michael@paquier.xyz>
@ 2025-07-24 02:56 ` Fujii Masao <masao.fujii@gmail.com>
0 siblings, 0 replies; 3+ messages in thread
From: Fujii Masao @ 2025-07-24 02:56 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; +Cc: Fujii Masao <masao.fujii@oss.nttdata.com>; pgsql-docs@lists.postgresql.org
On Tue, Jul 22, 2025 at 2:10 PM Michael Paquier <michael@paquier.xyz> wrote:
>
> On Thu, Jul 03, 2025 at 01:30:13AM +0900, Fujii Masao wrote:
> > BTW, all current index entries point to the top of the pg_buffercache
> > docs. Would it be better if each entry pointed directly to its relevant
> > section using a zone attribute like this?
> >
> > - <indexterm>
> > + <indexterm zone="pgbuffercache-summary">
> > <primary>pg_buffercache_summary</primary>
> > </indexterm>
>
> That would be smarter than the current statu-quo of the page,
> especially if this page grows more in size in the future.
The summary descriptions for each function and view are currently
at the top of the docs. If we update the index entries to point directly
to the relevant sections instead of the top, it might also make sense
to move those summaries into their respective sections.
I’ll consider this later.
> The other inconsistencies are good catches, by the way!
Thanks for the review! I've pushed the patch.
Regards,
--
Fujii Masao
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2025-07-24 02:56 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-07-02 16:30 Minor Improvements to pg_buffercache documentation Fujii Masao <masao.fujii@oss.nttdata.com>
2025-07-22 05:10 ` Michael Paquier <michael@paquier.xyz>
2025-07-24 02:56 ` Fujii Masao <masao.fujii@gmail.com>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox