Minor Improvements to pg_buffercache documentation

From: Fujii Masao <masao(dot)fujii(at)oss(dot)nttdata(dot)com>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Minor Improvements to pg_buffercache documentation
Date: 2025-07-02 16:30:13
Message-ID: 7d19af4b-7da3-4862-9f52-ff958960bd8d@oss.nttdata.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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

Attachment Content-Type Size
v1-0001-doc-Add-missing-index-entries-and-fix-title-forma.patch text/plain 2.0 KB

Browse pgsql-docs by date

  From Date Subject
Next Message Fujii Masao 2025-07-03 14:13:05 Re: Mention idle_replication_slot_timeout in pg_replication_slots docs
Previous Message Fujii Masao 2025-07-02 07:12:20 Re: Mention idle_replication_slot_timeout in pg_replication_slots docs