Lots of comment-fixing, and minor cosmetic cleanup, in pg_dump/parallel.c.
authorTom Lane
Sat, 28 May 2016 18:02:11 +0000 (14:02 -0400)
committerTom Lane
Sat, 28 May 2016 18:02:11 +0000 (14:02 -0400)
commit24c1f64a66d6f7a6448d0c9aedecf3e47a2a0c5e
tree3bfa72d6648ecbd19de7daa305578f69e31399c2
parent8b97208ecb44f41d159237822f4fa7214075ea75
Lots of comment-fixing, and minor cosmetic cleanup, in pg_dump/parallel.c.

The commentary in this file was in extremely sad shape.  The author(s)
had clearly never heard of the project convention that a function header
comment should provide an API spec of some sort for that function.  Much
of it was flat out wrong, too --- maybe it was accurate when written, but
if so it had not been updated to track subsequent code revisions.  Rewrite
and rearrange to try to bring it up to speed, and annotate some of the
places where more work is needed.  (I've refrained from actually fixing
anything of substance ... yet.)

Also, rename a couple of functions for more clarity as to what they do,
do some very minor code rearrangement, remove some pointless Asserts,
fix an incorrect Assert in readMessageFromPipe, and add a missing socket
close in one error exit from pgpipe().  The last would be a bug if we
tried to continue after pgpipe() failure, but since we don't, it's just
cosmetic at present.

Although this is only cosmetic, back-patch to 9.3 where parallel.c was
added.  It's sufficiently invasive that it'll pose a hazard for future
back-patching if we don't.

Discussion: <25239.1464386067@sss.pgh.pa.us>
src/bin/pg_dump/parallel.c
src/bin/pg_dump/pg_backup_archiver.c