pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Fujii Masao <fujii@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: Fix incorrect and inconsistent comments in tableam.h and heapam.
Date: Wed, 24 Sep 2025 15:54:04 +0000
Message-ID: <E1v1Roi-002Kwa-1S@gemulon.postgresql.org> (raw)

Fix incorrect and inconsistent comments in tableam.h and heapam.c.

This commit corrects several issues in function comments:

* The parameter "rel" was incorrectly referred to as "relation" in the comments
   for table_tuple_delete(), table_tuple_update(), and table_tuple_lock().
* In table_tuple_delete(), "changingPart" was listed as an output parameter
   in the comments but is actually input.
* In table_tuple_update(), "slot" was listed as an input parameter
   in the comments but is actually output.
* The comment for "update_indexes" in table_tuple_update() was mis-indented.
* The comments for heap_lock_tuple() incorrectly referenced a non-existent
   "tid" parameter.

Author: Chao Li <lic@highgo.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CAEoWx2nB6Ay8g=KEn7L3qbYX_4+sLk9XOMkV0XZqHR4cTY8ZvQ@mail.gmail.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/7fcb32ad023a434e07b7214c1c762ecd410b6969

Modified Files
--------------
src/backend/access/heap/heapam.c |  1 -
src/include/access/tableam.h     | 16 +++++++++-------
2 files changed, 9 insertions(+), 8 deletions(-)



Message-ID: <E1v1Roi-002Kwa-1S@gemulon.postgresql.org>
Permalink:  ../E1v1Roi-002Kwa-1S@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1v1Roi-002Kwa-1S@gemulon.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: fujii@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: Fix incorrect and inconsistent comments in tableam.h and heapam.
  In-Reply-To: <E1v1Roi-002Kwa-1S@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox