diff options
| author | Heikki Linnakangas <heikki.linnakangas@iki.fi> | 2024-03-20 10:13:39 +0200 |
|---|---|---|
| committer | Heikki Linnakangas <heikki.linnakangas@iki.fi> | 2024-03-20 10:13:39 +0200 |
| commit | c33084205a865538212b7edd99ab5de8e7220fb7 (patch) | |
| tree | 149730389541682e8878823574c72271a6967bd1 /src/backend/access/heap/pruneheap.c | |
| parent | 522ed12f7c600243870b13d9ff59f8fd5af10978 (diff) | |
Reorganize heap_page_prune() function comment
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
Diffstat (limited to 'src/backend/access/heap/pruneheap.c')
| -rw-r--r-- | src/backend/access/heap/pruneheap.c | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/src/backend/access/heap/pruneheap.c b/src/backend/access/heap/pruneheap.c index 4f12413b8b1..15adfdc11b2 100644 --- a/src/backend/access/heap/pruneheap.c +++ b/src/backend/access/heap/pruneheap.c @@ -197,18 +197,17 @@ heap_page_prune_opt(Relation relation, Buffer buffer) * array following array truncation by us. * * vistest is used to distinguish whether tuples are DEAD or RECENTLY_DEAD - * (see heap_prune_satisfies_vacuum and - * HeapTupleSatisfiesVacuum). + * (see heap_prune_satisfies_vacuum). * - * mark_unused_now indicates whether or not dead items can be set LP_UNUSED during - * pruning. - * - * off_loc is the offset location required by the caller to use in error - * callback. + * mark_unused_now indicates whether or not dead items can be set LP_UNUSED + * during pruning. * * presult contains output parameters needed by callers such as the number of * tuples removed and the number of line pointers newly marked LP_DEAD. * heap_page_prune() is responsible for initializing it. + * + * off_loc is the offset location required by the caller to use in error + * callback. */ void heap_page_prune(Relation relation, Buffer buffer, |