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