pg_combinebackup: Fix incorrect code documentation
authorDaniel Gustafsson <dgustafsson@postgresql.org>
Tue, 15 Apr 2025 13:27:08 +0000 (15:27 +0200)
committerDaniel Gustafsson <dgustafsson@postgresql.org>
Tue, 15 Apr 2025 13:27:08 +0000 (15:27 +0200)
The code comment for parse_oid accidentally used the wrong parameter
when referring to the location of the last backup. Also, while there,
improve sentence wording by removing a superfluous word.

Backpatch to v17 where pg_combinebackup was addedd

Author: Amul Sul <sulamul@gmail.com>
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Reviewed-by: Robert Haas <robertmhaas@gmail.com>
Discussion: https://postgr.es/m/CAAJ_b95ecWgzcS4K3Dx0E_Yp-SLwK5JBasFgioKMSjhQLw9xvg@mail.gmail.com
Backpatch-through: 17

src/bin/pg_combinebackup/pg_combinebackup.c

index 4f8ba156336425c084d8fb04e8010e52d83cd1be..69e5fd31a73412e1bfa5f84442a9251ee4777da5 100644 (file)
@@ -814,7 +814,7 @@ parse_oid(char *s, Oid *result)
  * Copy files from the input directory to the output directory, reconstructing
  * full files from incremental files as required.
  *
- * If processing is a user-defined tablespace, the tsoid should be the OID
+ * If processing a user-defined tablespace, the tsoid should be the OID
  * of that tablespace and input_directory and output_directory should be the
  * toplevel input and output directories for that tablespace. Otherwise,
  * tsoid should be InvalidOid and input_directory and output_directory should
@@ -826,7 +826,7 @@ parse_oid(char *s, Oid *result)
  *
  * n_prior_backups is the number of prior backups that we have available.
  * This doesn't count the very last backup, which is referenced by
- * output_directory, just the older ones. prior_backup_dirs is an array of
+ * input_directory, just the older ones. prior_backup_dirs is an array of
  * the locations of those previous backups.
  */
 static void