Re: Comment typo in tableam.h
Ashwin Agrawal <aagrawal@pivotal.io>
From: Ashwin Agrawal <aagrawal@pivotal.io>
To: Andres Freund <andres@anarazel.de>
Cc: David Rowley <david.rowley@2ndquadrant.com>,
Antonin Houska <ah@cybertec.at>,
PostgreSQL-development <pgsql-hackers@postgresql.org>
Date: 2019-06-04T01:41:35Z
Lists: pgsql-hackers
On Mon, Jun 3, 2019 at 6:24 PM Andres Freund <andres@anarazel.de> wrote: > Hi, > > On 2019-06-03 18:21:56 -0700, Ashwin Agrawal wrote: > > On Mon, Jun 3, 2019 at 5:26 PM Andres Freund <andres@anarazel.de> wrote: > > > > > Hi, > > > > > > Thanks for these! > > > > > > On 2019-06-03 17:24:15 -0700, Ashwin Agrawal wrote: > > > > /* > > > > * Estimate the size of shared memory needed for a parallel > scan > > > of this > > > > - * relation. The snapshot does not need to be accounted for. > > > > + * relation. > > > > */ > > > > Size (*parallelscan_estimate) (Relation rel); > > > > > > That's not a typo? > > > > > > > The snapshot is not passed as argument to that function hence seems weird > > to refer to snapshot in the comment, as anyways callback function can't > > account for it. > > It's part of the parallel scan struct, and it used to be accounted for > by pre tableam function... > Reads like the comment written from past context then, and doesn't have much value now. Its confusing than helping, to state not to account for snapshot and not any other field. table_parallelscan_estimate() has snapshot argument and it accounts for it, but callback doesn't. I am not sure how a callback would explicitly use that comment and avoid accounting for snapshot if its using generic ParallelTableScanDescData. But if you feel is helpful, please feel free to keep that text.
Commits
-
tableam: comment improvements.
- fa7bb9345370 12.0 landed
- 21039555cdec 13.0 landed
-
Fix few typos and minor word smithing in tableam comments.
- e33a1435be55 12.0 landed
-
Fix few typos and minor wordsmithing in tableam comments.
- bd56cd75d2ce 13.0 landed
-
Add missing assertions for required table am callbacks.
- e5eba10d79bd 12.0 landed
- 78d41f6c9b0e 13.0 landed
-
Fix incorrect parameter name in comment
- 72b6223f766d 12.0 landed