Fix inconsistency in the pg_buffercache documentation
Hi hackers,
While working on [1]/messages/by-id/Z/fFA2heH6lpSLlt@ip-10-97-1-34.eu-west-3.compute.internal, I noticed an inconsistency in the pg_buffercache
documentation: ba2a3c2302f1 missed to add "the" before the pg_buffercache_numa()
function introduction.
PFA a tiny patch to add it for consistency purpose. Should be back-patched to
18 where pg_buffercache_numa() has been introduced.
[1]: /messages/by-id/Z/fFA2heH6lpSLlt@ip-10-97-1-34.eu-west-3.compute.internal
Regards,
--
Bertrand Drouvot
PostgreSQL Contributors Team
RDS Open Source Databases
Amazon Web Services: https://aws.amazon.com
Attachments:
v1-0001-Fix-inconsistency-in-the-pg_buffercache-documenta.patchtext/x-diff; charset=us-asciiDownload
From 11d298a6bf2c95e5fbf77d4b7d48869173afa591 Mon Sep 17 00:00:00 2001
From: Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
Date: Wed, 2 Jul 2025 06:00:12 +0000
Subject: [PATCH v1] Fix inconsistency in the pg_buffercache documentation
ba2a3c2302f1 missed to add "the" before the pg_buffercache_numa() function
introduction. Adding it for consistency purpose.
---
doc/src/sgml/pgbuffercache.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 537d6014942..8a6fd54775e 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -37,7 +37,7 @@
<para>
This module provides the <function>pg_buffercache_pages()</function>
- function (wrapped in the <structname>pg_buffercache</structname> view),
+ function (wrapped in the <structname>pg_buffercache</structname> view), the
<function>pg_buffercache_numa_pages()</function> function (wrapped in the
<structname>pg_buffercache_numa</structname> view), the
<function>pg_buffercache_summary()</function> function, the
--
2.34.1
On 2 Jul 2025, at 08:23, Bertrand Drouvot <bertranddrouvot.pg@gmail.com> wrote:
Hi hackers,
While working on [1], I noticed an inconsistency in the pg_buffercache
documentation: ba2a3c2302f1 missed to add "the" before the pg_buffercache_numa()
function introduction.
Thanks, that does indeed look like an omission. There seems to be a few more
on the same page however, how about the attached?
--
Daniel Gustafsson
Attachments:
pg_buffercache.diffapplication/octet-stream; name=pg_buffercache.diff; x-unix-mode=0644Download
diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 537d6014942..546ace8369e 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -37,12 +37,12 @@
<para>
This module provides the <function>pg_buffercache_pages()</function>
- function (wrapped in the <structname>pg_buffercache</structname> view),
+ function (wrapped in the <structname>pg_buffercache</structname> view), the
<function>pg_buffercache_numa_pages()</function> function (wrapped in the
<structname>pg_buffercache_numa</structname> view), the
<function>pg_buffercache_summary()</function> function, the
<function>pg_buffercache_usage_counts()</function> function, the
- <function>pg_buffercache_evict()</function>, the
+ <function>pg_buffercache_evict()</function> function, the
<function>pg_buffercache_evict_relation()</function> function and the
<function>pg_buffercache_evict_all()</function> function.
</para>
@@ -55,7 +55,7 @@
</para>
<para>
- The <function>pg_buffercache_numa_pages()</function> provides
+ The <function>pg_buffercache_numa_pages()</function> function provides
<acronym>NUMA</acronym> node mappings for shared buffer entries. This
information is not part of <function>pg_buffercache_pages()</function>
itself, as it is much slower to retrieve.
Hi,
On Wed, Jul 02, 2025 at 09:55:52AM +0200, Daniel Gustafsson wrote:
On 2 Jul 2025, at 08:23, Bertrand Drouvot <bertranddrouvot.pg@gmail.com> wrote:
Hi hackers,
While working on [1], I noticed an inconsistency in the pg_buffercache
documentation: ba2a3c2302f1 missed to add "the" before the pg_buffercache_numa()
function introduction.Thanks, that does indeed look like an omission.
Thanks for looking at it!
There seems to be a few more
on the same page however,
Indeed, there is multiple kind of inconsistency that are worth to fix.
how about the attached?
LGTM.
Regards,
--
Bertrand Drouvot
PostgreSQL Contributors Team
RDS Open Source Databases
Amazon Web Services: https://aws.amazon.com