Fix some comments of do_pg_backup_start() and do_pg_backup_stop()

michaelpq · michaelpq · commit 2e560b974ec7 · 2022-09-28T09:58:44.000+09:00
Both functions referred to an incorrect variable name, so make the whole more consistent. Oversight in 7d70809. Author: Kyotaro Horiguchi, Bharath Rupireddy Discussion: https://postgr.es/m/20220927.172427.467118514018439476.horikyota.ntt@gmail.com
diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c
@@ -8316,9 +8316,9 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli)
  * symlinks while extracting files from tar. However for consistency and
  * platform-independence, we do it the same way everywhere.
  *
- * It fills in backup_state with the information required for the backup,
- * such as the minimum WAL location that must be present to restore from
- * this backup (starttli) and the corresponding timeline ID (starttli).
+ * It fills in "state" with the information required for the backup, such
+ * as the minimum WAL location that must be present to restore from this
+ * backup (starttli) and the corresponding timeline ID (starttli).
  *
  * Every successfully started backup must be stopped by calling
  * do_pg_backup_stop() or do_pg_abort_backup(). There can be many
@@ -8634,7 +8634,7 @@ get_backup_status(void)
  * file (if required), resets sessionBackupState and so on.  It can optionally
  * wait for WAL segments to be archived.
  *
- * backup_state is filled with the information necessary to restore from this
+ * "state" is filled with the information necessary to restore from this
  * backup with its stop LSN (stoppoint), its timeline ID (stoptli), etc.
  *
  * It is the responsibility of the caller of this function to verify the

Original file line number	Diff line number	Diff line change
`@@ -8316,9 +8316,9 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli)`
`8316`	`8316`	`* symlinks while extracting files from tar. However for consistency and`
`8317`	`8317`	`* platform-independence, we do it the same way everywhere.`
`8318`	`8318`	`*`
`8319`		`- * It fills in backup_state with the information required for the backup,`
`8320`		`- * such as the minimum WAL location that must be present to restore from`
`8321`		`- * this backup (starttli) and the corresponding timeline ID (starttli).`
	`8319`	`+ * It fills in "state" with the information required for the backup, such`
	`8320`	`+ * as the minimum WAL location that must be present to restore from this`
	`8321`	`+ * backup (starttli) and the corresponding timeline ID (starttli).`
`8322`	`8322`	`*`
`8323`	`8323`	`* Every successfully started backup must be stopped by calling`
`8324`	`8324`	`* do_pg_backup_stop() or do_pg_abort_backup(). There can be many`
`@@ -8634,7 +8634,7 @@ get_backup_status(void)`
`8634`	`8634`	`* file (if required), resets sessionBackupState and so on. It can optionally`
`8635`	`8635`	`* wait for WAL segments to be archived.`
`8636`	`8636`	`*`
`8637`		`- * backup_state is filled with the information necessary to restore from this`
	`8637`	`+ * "state" is filled with the information necessary to restore from this`
`8638`	`8638`	`* backup with its stop LSN (stoppoint), its timeline ID (stoptli), etc.`
`8639`	`8639`	`*`
`8640`	`8640`	`* It is the responsibility of the caller of this function to verify the`