[PATCH] Fix inconsistent title attribute tags in documentation

Started by Noboru Saitoabout 1 month ago3 messages
#1Noboru Saito
noborusai@gmail.com
1 attachment(s)

Hi PostgreSQL Hackers,

I'm a member of the PostgreSQL Japanese documentation translation team.
While working on the translation, I found some inconsistent title
attribute tags in the documentation.

I am submitting a patch to fix these tag inconsistencies in pgbuffercache.sgml.
This has been an issue since version 18.
Please find the attached patch.

Best regards,
Noboru Saito

Attachments:

0001-Change-function-title-tags-from-structname-to-functi.patchtext/x-patch; charset=US-ASCII; name=0001-Change-function-title-tags-from-structname-to-functi.patchDownload
From 1842195d48346cda2ed09c563d36b5b781cfa0b3 Mon Sep 17 00:00:00 2001
From: Noboru Saito <noborusai@gmail.com>
Date: Tue, 9 Dec 2025 07:09:50 +0900
Subject: [PATCH] Change function title tags from <structname> to <function>

---
 doc/src/sgml/pgbuffercache.sgml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
index 2e1b9bbecf4..1e9aee10275 100644
--- a/doc/src/sgml/pgbuffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -585,7 +585,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-evict-relation">
-  <title>The <structname>pg_buffercache_evict_relation()</structname> Function</title>
+  <title>The <function>pg_buffercache_evict_relation()</function> Function</title>
   <para>
    The <function>pg_buffercache_evict_relation()</function> function is very
    similar to the <function>pg_buffercache_evict()</function> function.  The
@@ -603,7 +603,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-evict-all">
-  <title>The <structname>pg_buffercache_evict_all()</structname> Function</title>
+  <title>The <function>pg_buffercache_evict_all()</function> Function</title>
   <para>
    The <function>pg_buffercache_evict_all()</function> function is very
    similar to the <function>pg_buffercache_evict()</function> function.  The
@@ -619,7 +619,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-mark-dirty">
-  <title>The <structname>pg_buffercache_mark_dirty</structname> Function</title>
+  <title>The <function>pg_buffercache_mark_dirty()</function> Function</title>
   <para>
    The <function>pg_buffercache_mark_dirty()</function> function takes a
    buffer identifier, as shown in the <structfield>bufferid</structfield>
@@ -637,7 +637,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-mark-dirty-relation">
-  <title>The <structname>pg_buffercache_mark_dirty_relation</structname> Function</title>
+  <title>The <function>pg_buffercache_mark_dirty_relation()</function> Function</title>
   <para>
    The <function>pg_buffercache_mark_dirty_relation()</function> function is
    very similar to the
@@ -656,7 +656,7 @@
  </sect2>
 
  <sect2 id="pgbuffercache-pg-buffercache-mark-dirty-all">
-  <title>The <structname>pg_buffercache_mark_dirty_all</structname> Function</title>
+  <title>The <function>pg_buffercache_mark_dirty_all()</function> Function</title>
   <para>
    The <function>pg_buffercache_mark_dirty_all()</function> function is
    very similar to the <function>pg_buffercache_mark_dirty()</function>
-- 
2.43.0

#2Nathan Bossart
nathandbossart@gmail.com
In reply to: Noboru Saito (#1)
Re: [PATCH] Fix inconsistent title attribute tags in documentation

On Tue, Dec 09, 2025 at 07:33:17AM +0900, Noboru Saito wrote:

I'm a member of the PostgreSQL Japanese documentation translation team.
While working on the translation, I found some inconsistent title
attribute tags in the documentation.

I am submitting a patch to fix these tag inconsistencies in pgbuffercache.sgml.
This has been an issue since version 18.
Please find the attached patch.

Looks correct to me. I grepped around a bit and didn't find any other
similar problems.

--
nathan

#3Nathan Bossart
nathandbossart@gmail.com
In reply to: Nathan Bossart (#2)
Re: [PATCH] Fix inconsistent title attribute tags in documentation

Committed, thanks for the patch!

--
nathan