diff --git a/doc/pgprobackup.xml b/doc/pgprobackup.xml
index f4ce9f4d..431a60fe 100644
--- a/doc/pgprobackup.xml
+++ b/doc/pgprobackup.xml
@@ -2239,7 +2239,7 @@ BACKUP INSTANCE 'node'
MERGED — the backup data files were
successfully merged, but its metadata is in the process
- of been updated. Only full backup can have this status.
+ of being updated. Only full backups can have this status.
@@ -3169,16 +3169,16 @@ ARCHIVE INSTANCE 'node'
pg_probackup merge -B backup_dir --instance instance_name -i backup_id
- This command merges the specified incremental backup to its
- parent full backup, together with all incremental backups
- between them. If the specified backup ID belong to the full backup,
- then it will be merged with the closest incremental backup.
- Once the merge is complete, the incremental
- backups are removed as redundant. Thus, the merge operation is
- virtually equivalent to retaking a full backup and removing all
- the outdated backups, but it allows to save much time,
- especially for large data volumes, as well as I/O and network traffic
- if you are using pg_probackup in the
+ This command merges backups that belong to a common incremental backup
+ chain. If you specify a full backup, it will be merged with its first
+ incremental backup. If you specify an incremental backup, it will be
+ merged to its parent full backup, together with all incremental backups
+ between them. Once the merge is complete, the full backup takes in all
+ the merged data, and the incremental backups are removed as redundant.
+ Thus, the merge operation is virtually equivalent to retaking a full
+ backup and removing all the outdated backups, but it allows to save much
+ time, especially for large data volumes, as well as I/O and network
+ traffic if you are using pg_probackup in the
remote mode.
@@ -3192,8 +3192,10 @@ pg_probackup show -B backup_dir --instance
If the merge is still in progress, the backup status is
- displayed as MERGING or, at the final stage,
- MERGED. The merge is idempotent, so you can
+ displayed as MERGING. For full backups,
+ it can also be shown as MERGED while the
+ metadata is being updated at the final stage of the merge.
+ The merge is idempotent, so you can
restart the merge if it was interrupted.
@@ -3591,9 +3593,11 @@ pg_probackup backup -B backup_dir -b bac
Do not sync backed up files to disk. You can use this flag to speed
- up backup process. Using this flag can result in data
+ up the backup process. Using this flag can result in data
corruption in case of operating system or hardware crash.
- Corruption can be detected by backup validation.
+ If you use this option, it is recommended to run the
+ command once the backup is complete
+ to detect possible issues.
@@ -3627,7 +3631,7 @@ pg_probackup restore -B backup_dir --instance cmdline]
[--primary-conninfo=primary_conninfo]
-[-S | --primary-slot-name=slotname]
+[-S | --primary-slot-name=slot_name]
[recovery_target_options] [logging_options] [remote_options]
[partial_restore_options] [remote_wal_archive_options]
@@ -3672,7 +3676,7 @@ pg_probackup restore -B backup_dir --instance primary_conninfo
parameter to the specified value.
- This option will be ignored unless the flag if specified.
+ This option will be ignored unless the flag is specified.
Example: --primary-conninfo='host=192.168.1.50 port=5432 user=foo password=foopass'
@@ -3688,7 +3692,7 @@ pg_probackup restore -B backup_dir --instance primary_slot_name
parameter to the specified value.
- This option will be ignored unless the flag if specified.
+ This option will be ignored unless the flag is specified.
@@ -3785,6 +3789,8 @@ pg_probackup restore -B backup_dir --instance
+ command again.
@@ -3912,12 +3918,12 @@ pg_probackup merge -B backup_dir --instance logging_options]
- Merges the specified incremental backup to its parent full
- backup, together with all incremental backups between them, if
- any. If the specified backup ID belong to the full backup,
- then it will be merged with the closest incremental backup.
- As a result, the full backup takes in all the merged
- data, and the incremental backups are removed as redundant.
+ Merges backups that belong to a common incremental backup
+ chain. If you specify a full backup, it will be merged with its first
+ incremental backup. If you specify an incremental backup, it will be
+ merged to its parent full backup, together with all incremental backups
+ between them. Once the merge is complete, the full backup takes in all
+ the merged data, and the incremental backups are removed as redundant.
For details, see the section
@@ -3981,24 +3987,25 @@ pg_probackup archive-push -B backup_dir --instance --overwrite flag.
- Every file is copied to a temporary file with the
+ Each file is copied to a temporary file with the
.part suffix. If the temporary file already
exists, pg_probackup will wait
seconds before discarding it.
After the copy is done, atomic rename is performed.
This algorithm ensures that a failed archive-push
will not stall continuous archiving and that concurrent archiving from
- multiple sources into a single WAL archive have no risk of archive
+ multiple sources into a single WAL archive has no risk of archive
corruption.
- To speed up archiving, especially in remote mode, archive-push
- can be run on multiple threads using option.
- Files can also be copied in batches using option .
+ To speed up archiving, you can specify the option
+ to run archive-push on multiple threads.
+ If you provide the option, WAL files
+ will be copied in batches of the specified size.
WAL segments copied to the archive are synced to disk unless
- flag is used.
+ the flag is used.
You can use archive-push in the
@@ -4104,7 +4111,7 @@ pg_probackup archive-get -B backup_dir --instance
Sets the number of parallel threads for backup,
restore, merge,
- validate, checkdb and
+ validate, checkdb, and
archive-push processes.
@@ -4766,11 +4773,11 @@ pg_probackup archive-get -B backup_dir --instance
-
+
- Sets the maximum number of files to be copied into archive by signle
- archive-push process.
+ Sets the maximum number of files that can be copied into the archive
+ by a single archive-push process.
@@ -4779,7 +4786,9 @@ pg_probackup archive-get -B backup_dir --instance
- Sets the timeout for considering existing .part file to be stale. By default pg_probackup waits 300 seconds.
+ Sets the timeout for considering existing .part
+ files to be stale. By default, pg_probackup
+ waits 300 seconds.
@@ -4788,9 +4797,9 @@ pg_probackup archive-get -B backup_dir --instance
- Do not rename status files in archive_status directory.
+ Do not rename status files in the archive_status directory.
This option should be used only if archive_command
- contain multiple commands.
+ contains multiple commands.