db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-30 05:39:12 +02:00
Code Issues Releases Activity

Document the relationship between the archive-copy and archive-check options.

Browse Source 
Suggested by Markus Nullmeier.
This commit is contained in:
David Steele 2017-12-11 07:48:30 -05:00
parent 58b0893067
commit 0bfda1a908
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/xml/reference.xml
View File

@ -397,7 +397,9 @@
<config-key id="archive-check" name="Check Archive">
<summary>Check that WAL segments are present in the archive before backup completes.</summary>
<text>Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.</text>
<text>Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.
This option must be enabled if <br-option>archive-copy</br-option> is enabled.</text>
<example>n</example>
</config-key>
@ -408,7 +410,9 @@
<text>This slightly paranoid option protects against corruption in the WAL segment archive by storing the WAL segments required for consistency directly in the backup. WAL segments are still stored in the archive so this option will use additional space.
On restore, the WAL segments will be present in <path>pg_xlog/pg_wal</path> and <postgres/> will use them in preference to calling the <code>restore_command</code>.</text>
On restore, the WAL segments will be present in <path>pg_xlog/pg_wal</path> and <postgres/> will use them in preference to calling the <code>restore_command</code>.
The <br-option>archive-check</br-option> option must be enabled if <br-option>archive-copy</br-option> is enabled.</text>
<example>y</example>
</config-key>

13
doc/xml/release.xml
View File

@ -79,6 +79,14 @@
<release-doc-list>
<release-feature-list>
<release-item>
<release-item-contributor-list>
<release-item-ideator id="nullmeier.markus"/>
</release-item-contributor-list>
<p>Document the relationship between the <br-option>archive-copy</br-option> and <br-option>archive-check</br-option> options.</p>
</release-item>
<release-item>
<p>Improve <br-option>archive-copy</br-option> reference documentation.</p>
</release-item>
@ -3842,6 +3850,11 @@
<contributor-id type="github">jmccormick2001</contributor-id>
</contributor>
<contributor id="nullmeier.markus">
<contributor-name-display>Markus Nullmeier</contributor-name-display>
<contributor-id type="github">mnullmei</contributor-id>
</contributor>
<contributor id="odonnell.jason">
<contributor-name-display>Jason O'Donnell</contributor-name-display>
<contributor-id type="github">Dwaligon</contributor-id>