database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

Reorganize heap_page_prune() function comment

Browse Source 
heap_page_prune()'s function header comment didn't explain the
parameters in the same order they appear in the function. Fix that.

Author: Melanie Plageman <melanieplageman@gmail.com>
Discussion: https://www.postgresql.org/message-id/20240320013602.6sypr4cx6sefpemg@liskov
This commit is contained in:
Heikki Linnakangas
2024-03-20 10:13:39 +02:00
parent 522ed12f7c
commit c33084205a
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/backend/access/heap/pruneheap.c
View File

@ -197,18 +197,17 @@ heap_page_prune_opt(Relation relation, Buffer buffer)
* array following array truncation by us. * array following array truncation by us.
* *
* vistest is used to distinguish whether tuples are DEAD or RECENTLY_DEAD * vistest is used to distinguish whether tuples are DEAD or RECENTLY_DEAD
* (see heap_prune_satisfies_vacuum and * (see heap_prune_satisfies_vacuum).
* HeapTupleSatisfiesVacuum).
* *
* mark_unused_now indicates whether or not dead items can be set LP_UNUSED during * mark_unused_now indicates whether or not dead items can be set LP_UNUSED
* pruning. * during pruning.
*
* off_loc is the offset location required by the caller to use in error
* callback.
* *
* presult contains output parameters needed by callers such as the number of * presult contains output parameters needed by callers such as the number of
* tuples removed and the number of line pointers newly marked LP_DEAD. * tuples removed and the number of line pointers newly marked LP_DEAD.
* heap_page_prune() is responsible for initializing it. * heap_page_prune() is responsible for initializing it.
*
* off_loc is the offset location required by the caller to use in error
* callback.
*/ */
void void
heap_page_prune(Relation relation, Buffer buffer, heap_page_prune(Relation relation, Buffer buffer,