Commitc330842

committed

Reorganize heap_page_prune() function comment

heap_page_prune()'s function header comment didn't explain theparameters 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

1 parent522ed12 commitc330842Copy full SHA for c330842

File tree

-7

lines changed

-7

lines changed

Lines changed: 6 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -197,18 +197,17 @@ heap_page_prune_opt(Relation relation, Buffer buffer)`
`197`	`197`	`* array following array truncation by us.`
`198`	`198`	`*`
`199`	`199`	`* vistest is used to distinguish whether tuples are DEAD or RECENTLY_DEAD`
`200`		`- * (see heap_prune_satisfies_vacuum and`
`201`		`- * HeapTupleSatisfiesVacuum).`
	`200`	`+ * (see heap_prune_satisfies_vacuum).`
`202`	`201`	`*`
`203`		`- * mark_unused_now indicates whether or not dead items can be set LP_UNUSED during`
`204`		`- * pruning.`
`205`		`- *`
`206`		`- * off_loc is the offset location required by the caller to use in error`
`207`		`- * callback.`
	`202`	`+ * mark_unused_now indicates whether or not dead items can be set LP_UNUSED`
	`203`	`+ * during pruning.`
`208`	`204`	`*`
`209`	`205`	`* presult contains output parameters needed by callers such as the number of`
`210`	`206`	`* tuples removed and the number of line pointers newly marked LP_DEAD.`
`211`	`207`	`* heap_page_prune() is responsible for initializing it.`
	`208`	`+ *`
	`209`	`+ * off_loc is the offset location required by the caller to use in error`
	`210`	`+ * callback.`
`212`	`211`	`*/`
`213`	`212`	`void`
`214`	`213`	`heap_page_prune(Relationrelation,Bufferbuffer,`

Comments

(0)