From fe12ba8f0ec663f4778e6b46053739ad4ec20514 Mon Sep 17 00:00:00 2001 From: Justin Pryzby Date: Thu, 24 Dec 2020 00:01:43 -0600 Subject: [PATCH 07/20] fix comments --- src/bin/pg_dump/compress_io.c | 15 +++++++-------- src/bin/pg_dump/pg_backup_directory.c | 4 ++-- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/src/bin/pg_dump/compress_io.c b/src/bin/pg_dump/compress_io.c index 285f554c1a..fa94148cdf 100644 --- a/src/bin/pg_dump/compress_io.c +++ b/src/bin/pg_dump/compress_io.c @@ -13,7 +13,7 @@ * friends, providing an interface similar to those, but abstracts away * the possible compression. Both APIs use libz for the compression, but * the second API uses gzip headers, so the resulting files can be easily - * manipulated with the gzip utility. + * manipulated with the gzip utility. XXX * * Compressor API * -------------- @@ -41,9 +41,9 @@ * libz's gzopen() APIs. It allows you to use the same functions for * compressed and uncompressed streams. cfopen_read() first tries to open * the file with given name, and if it fails, it tries to open the same - * file with the .gz suffix. cfopen_write() opens a file for writing, an + * file with a compressed suffix. cfopen_write() opens a file for writing, an * extra argument specifies if the file should be compressed, and adds the - * .gz suffix to the filename if so. This allows you to easily handle both + * compressed suffix to the filename if so. This allows you to easily handle both * compressed and uncompressed files. * * IDENTIFICATION @@ -646,8 +646,8 @@ WriteDataToArchiveNone(ArchiveHandle *AH, CompressorState *cs, */ /* - * cfp represents an open stream, wrapping the underlying FILE or gzFile - * pointer. This is opaque to the callers. + * cfp represents an open stream, wrapping the underlying compressed or + * uncompressed file object. This is opaque to the callers. */ struct cfp { @@ -687,8 +687,7 @@ free_keep_errno(void *p) * be either "r" or "rb". * * If the file at 'path' does not exist, we search with compressed suffix (if 'path' - * doesn't already have one) and try again. So if you pass "foo" as 'path', - * this will open either "foo" or "foo.gz". + * doesn't already have one) and try again. * * On failure, return NULL with an error code in errno. */ @@ -745,7 +744,7 @@ cfopen_write(const char *path, const char *mode, Compress *compression) } /* - * Opens file 'path' in 'mode'. If 'compression' is non-zero, the file + * Opens file 'path' in 'mode'. If 'alg' is COMPR_ALG_ZLIB, the file * is opened with libz gzopen(), otherwise with plain fopen(). * * On failure, return NULL with an error code in errno. diff --git a/src/bin/pg_dump/pg_backup_directory.c b/src/bin/pg_dump/pg_backup_directory.c index b8efeb8ca7..f0ded2421d 100644 --- a/src/bin/pg_dump/pg_backup_directory.c +++ b/src/bin/pg_dump/pg_backup_directory.c @@ -6,8 +6,8 @@ * for the TOC, and a separate file for each data entry, named ".dat". * Large objects (BLOBs) are stored in separate files named "blob_.dat", * and there's a plain-text TOC file for them called "blobs.toc". If - * compression is used, each data file is individually compressed and the - * ".gz" suffix is added to the filenames. The TOC files are never + * compression is used, each data file is individually compressed with a + * suffix is added to the filenames. The TOC files are never * compressed by pg_dump, however they are accepted with the .gz suffix too, * in case the user has manually compressed them with 'gzip'. * -- 2.17.0