Fix and clarify function comment on LogicalTapeSetCreate.
authorHeikki Linnakangas <heikki.linnakangas@iki.fi>
Mon, 23 Jan 2023 09:56:43 +0000 (11:56 +0200)
committerHeikki Linnakangas <heikki.linnakangas@iki.fi>
Mon, 23 Jan 2023 09:56:43 +0000 (11:56 +0200)
commit236f1ea84c4ca6a29d790fac4b48eba12a74443c
tree3345c3742a66c1b36725039c3e0444c3e8d17ccf
parent67c5b8840fcad07eeecd9af517b9b1ff09a3cf8e
Fix and clarify function comment on LogicalTapeSetCreate.

Commit c4649cce39 removed the "shared" and "ntapes" arguments, but the
comment still talked about "shared". It also talked about "a shared
file handle", which was technically correct because even before commit
c4649cce39, the "shared file handle" referred to the "fileset"
argument, not "shared". But it was very confusing. Improve the
comment.

Also add a comment on what the "preallocate" argument does.

Backpatch to v15, just to make backpatching other patches easier in
the future.

Discussion: https://www.postgresql.org/message-id/af989685-91d5-aad4-8f60-1d066b5ec309@enterprisedb.com
Reviewed-by: Peter Eisentraut
src/backend/utils/sort/logtape.c