docs: Mention that pg_combinebackup does not verify backups.
authorRobert Haas <[email protected]>
Thu, 18 Apr 2024 13:52:19 +0000 (09:52 -0400)
committerRobert Haas <[email protected]>
Thu, 18 Apr 2024 13:52:19 +0000 (09:52 -0400)
We don't want users to think that pg_combinebackup is trying to check
the validity of individual backups, because it isn't. Adjust the wording
about sanity checks to make it clear that verification of individual
backups is the job of pg_verifybackup, and that the checks performed
by pg_combinebackup are around the relationships between the backups.

Per discussion with David Steele.

Discussion: http://postgr.es/m/e6f930c3-590c-47b9-b094-217bb2a3e22e@pgmasters.net

doc/src/sgml/ref/pg_combinebackup.sgml

index 658e9a759c8305aa578f4b033b68e8ed18d2551f..c21160a195bb61463f4875426b0a5a05e961f9a5 100644 (file)
@@ -45,12 +45,16 @@ PostgreSQL documentation
   </para>
 
   <para>
-   Although <application>pg_combinebackup</application> will attempt to verify
+   <application>pg_combinebackup</application> will attempt to verify
    that the backups you specify form a legal backup chain from which a correct
-   full backup can be reconstructed, it is not designed to help you keep track
-   of which backups depend on which other backups. If you remove the one or
-   more of the previous backups upon which your incremental
-   backup relies, you will not be able to restore it.
+   full backup can be reconstructed. However, it is not designed to help you
+   keep track of which backups depend on which other backups. If you remove
+   the one or more of the previous backups upon which your incremental
+   backup relies, you will not be able to restore it. Moreover,
+   <application>pg_combinebackup</application> only attempts to verify that the
+   backups have the correct relationship to each other, not that each
+   individual backup is intact; for that, use
+   <xref linkend="app-pgverifybackup" />.
   </para>
 
   <para>