Improve file header comments for astramer code.
authorRobert Haas <rhaas@postgresql.org>
Wed, 7 Aug 2024 12:49:41 +0000 (08:49 -0400)
committerRobert Haas <rhaas@postgresql.org>
Wed, 7 Aug 2024 12:49:41 +0000 (08:49 -0400)
commit22b4a1b561f830f2af80c21450a4c05f6efbb698
tree64d63c8157098c0e046583064ec1d6846e17750c
parent2676040df0b2ebbcf8af759dbe5d34f393c3d5b5
Improve file header comments for astramer code.

Make it clear that "astreamer" stands for "archive streamer".
Generalize comments that still believe this code can only be used
by pg_basebackup. Add some comments explaining the asymmetry
between the gzip, lz4, and zstd astreamers, in the hopes of making
life easier for anyone who hacks on this code in the future.

Robert Haas, reviewed by Amul Sul.

Discussion: http://postgr.es/m/CAAJ_b97O2kkKVTWxt8MxDN1o-cDfbgokqtiN2yqFf48=gXpcxQ@mail.gmail.com
src/fe_utils/astreamer_file.c
src/fe_utils/astreamer_gzip.c
src/fe_utils/astreamer_lz4.c
src/fe_utils/astreamer_zstd.c
src/include/fe_utils/astreamer.h