Content-Type: multipart/mixed; boundary="------------epLVyj7YkoCxKxWMymquO8Lv"
Message-ID: <7d19af4b-7da3-4862-9f52-ff958960bd8d@oss.nttdata.com>
Date: Thu, 3 Jul 2025 01:30:13 +0900
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Content-Language: en-US
To: pgsql-docs@lists.postgresql.org
From: Fujii Masao <masao.fujii@oss.nttdata.com>
Subject: Minor Improvements to pg_buffercache documentation
Archived-At: 
 <https://www.postgresql.org/message-id/7d19af4b-7da3-4862-9f52-ff958960bd8d%40oss.nttdata.com>
Precedence: bulk

This is a multi-part message in MIME format.
--------------epLVyj7YkoCxKxWMymquO8Lv
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

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

--------------epLVyj7YkoCxKxWMymquO8Lv
Content-Type: text/plain; charset=UTF-8;
 name="v1-0001-doc-Add-missing-index-entries-and-fix-title-forma.patch"
Content-Disposition: attachment;
 filename*0="v1-0001-doc-Add-missing-index-entries-and-fix-title-forma.pa";
 filename*1="tch"
Content-Transfer-Encoding: base64

RnJvbSAwNjAxM2QxZDFmYmFhNjRhYTk5ZjUwNjdiMjYwOGFiODMzYTkyYjNkIE1vbiBTZXAg
MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBGdWppaSBNYXNhbyA8ZnVqaWlAcG9zdGdyZXNxbC5v
cmc+CkRhdGU6IFRodSwgMyBKdWwgMjAyNSAwMDozNTo0NCArMDkwMApTdWJqZWN0OiBbUEFU
Q0ggdjFdIGRvYzogQWRkIG1pc3NpbmcgaW5kZXggZW50cmllcyBhbmQgZml4IHRpdGxlIGZv
cm1hdHRpbmcgaW4KIHBnX2J1ZmZlcmNhY2hlIGRvY3MuCgpUaGlzIGNvbW1pdCBhZGRzIG1p
c3NpbmcgaW5kZXggZW50cmllcyBmb3IgdGhlIGZ1bmN0aW9ucyBwZ19idWZmZXJjYWNoZV9u
dW1hKCkKYW5kIHBnX2J1ZmZlcmNhY2hlX3VzYWdlX2NvdW50cygpIGluIHRoZSBwZ19idWZm
ZXJjYWNoZSBkb2N1bWVudGF0aW9uLgoKSXQgYWxzbyBtYWtlcyB0aGUgZnVuY3Rpb24gdGl0
bGVzIGNvbnNpc3RlbnQgYnkgYWRkaW5nIHBhcmVudGhlc2VzIGFmdGVyCmZ1bmN0aW9uIG5h
bWVzIHdoZXJlIHRoZXkgd2VyZSBwcmV2aW91c2x5IG1pc3NpbmcuCi0tLQogZG9jL3NyYy9z
Z21sL3BnYnVmZmVyY2FjaGUuc2dtbCB8IDEyICsrKysrKysrKystLQogMSBmaWxlIGNoYW5n
ZWQsIDEwIGluc2VydGlvbnMoKyksIDIgZGVsZXRpb25zKC0pCgpkaWZmIC0tZ2l0IGEvZG9j
L3NyYy9zZ21sL3BnYnVmZmVyY2FjaGUuc2dtbCBiL2RvYy9zcmMvc2dtbC9wZ2J1ZmZlcmNh
Y2hlLnNnbWwKaW5kZXggNTQ2YWNlODM2OWUuLmVlYjg1YTBlMDQ5IDEwMDY0NAotLS0gYS9k
b2Mvc3JjL3NnbWwvcGdidWZmZXJjYWNoZS5zZ21sCisrKyBiL2RvYy9zcmMvc2dtbC9wZ2J1
ZmZlcmNhY2hlLnNnbWwKQEAgLTE5LDEwICsxOSwxOCBAQAogICA8cHJpbWFyeT5wZ19idWZm
ZXJjYWNoZV9wYWdlczwvcHJpbWFyeT4KICA8L2luZGV4dGVybT4KIAorIDxpbmRleHRlcm0+
CisgIDxwcmltYXJ5PnBnX2J1ZmZlcmNhY2hlX251bWE8L3ByaW1hcnk+CisgPC9pbmRleHRl
cm0+CisKICA8aW5kZXh0ZXJtPgogICA8cHJpbWFyeT5wZ19idWZmZXJjYWNoZV9zdW1tYXJ5
PC9wcmltYXJ5PgogIDwvaW5kZXh0ZXJtPgogCisgPGluZGV4dGVybT4KKyAgPHByaW1hcnk+
cGdfYnVmZmVyY2FjaGVfdXNhZ2VfY291bnRzPC9wcmltYXJ5PgorIDwvaW5kZXh0ZXJtPgor
CiAgPGluZGV4dGVybT4KICAgPHByaW1hcnk+cGdfYnVmZmVyY2FjaGVfZXZpY3Q8L3ByaW1h
cnk+CiAgPC9pbmRleHRlcm0+CkBAIC00ODksNyArNDk3LDcgQEAKICA8L3NlY3QyPgogCiAg
PHNlY3QyIGlkPSJwZ2J1ZmZlcmNhY2hlLXBnLWJ1ZmZlcmNhY2hlLWV2aWN0LXJlbGF0aW9u
Ij4KLSAgPHRpdGxlPlRoZSA8c3RydWN0bmFtZT5wZ19idWZmZXJjYWNoZV9ldmljdF9yZWxh
dGlvbjwvc3RydWN0bmFtZT4gRnVuY3Rpb248L3RpdGxlPgorICA8dGl0bGU+VGhlIDxzdHJ1
Y3RuYW1lPnBnX2J1ZmZlcmNhY2hlX2V2aWN0X3JlbGF0aW9uKCk8L3N0cnVjdG5hbWU+IEZ1
bmN0aW9uPC90aXRsZT4KICAgPHBhcmE+CiAgICBUaGUgPGZ1bmN0aW9uPnBnX2J1ZmZlcmNh
Y2hlX2V2aWN0X3JlbGF0aW9uKCk8L2Z1bmN0aW9uPiBmdW5jdGlvbiBpcyB2ZXJ5CiAgICBz
aW1pbGFyIHRvIHRoZSA8ZnVuY3Rpb24+cGdfYnVmZmVyY2FjaGVfZXZpY3QoKTwvZnVuY3Rp
b24+IGZ1bmN0aW9uLiAgVGhlCkBAIC01MDcsNyArNTE1LDcgQEAKICA8L3NlY3QyPgogCiAg
PHNlY3QyIGlkPSJwZ2J1ZmZlcmNhY2hlLXBnLWJ1ZmZlcmNhY2hlLWV2aWN0LWFsbCI+Ci0g
IDx0aXRsZT5UaGUgPHN0cnVjdG5hbWU+cGdfYnVmZmVyY2FjaGVfZXZpY3RfYWxsPC9zdHJ1
Y3RuYW1lPiBGdW5jdGlvbjwvdGl0bGU+CisgIDx0aXRsZT5UaGUgPHN0cnVjdG5hbWU+cGdf
YnVmZmVyY2FjaGVfZXZpY3RfYWxsKCk8L3N0cnVjdG5hbWU+IEZ1bmN0aW9uPC90aXRsZT4K
ICAgPHBhcmE+CiAgICBUaGUgPGZ1bmN0aW9uPnBnX2J1ZmZlcmNhY2hlX2V2aWN0X2FsbCgp
PC9mdW5jdGlvbj4gZnVuY3Rpb24gaXMgdmVyeQogICAgc2ltaWxhciB0byB0aGUgPGZ1bmN0
aW9uPnBnX2J1ZmZlcmNhY2hlX2V2aWN0KCk8L2Z1bmN0aW9uPiBmdW5jdGlvbi4gIFRoZQot
LSAKMi40OS4wCgo=

--------------epLVyj7YkoCxKxWMymquO8Lv--