pgsql: Fix incorrect and inconsistent comments in tableam.h and heapam. - Mailing list pgsql-committers

From Fujii Masao
Subject pgsql: Fix incorrect and inconsistent comments in tableam.h and heapam.
Date
Msg-id E1v1Roi-002Kwa-1S@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
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(-)


pgsql-committers by date:

Previous
From: Peter Eisentraut
Date:
Subject: pgsql: Remove PointerIsValid()
Next
From: Tom Lane
Date:
Subject: pgsql: Include pg_test_timing's full output in the TAP test log.