Improve archive-copy reference documentation.

pgbackrest · Dec 18, 2017 · b36d3a4 · b36d3a4
1 parent cd8f2d3
commit b36d3a4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/xml/reference.xml b/doc/xml/reference.xml
@@ -406,9 +406,9 @@
                     <config-key id="archive-copy" name="Copy Archive">
                         <summary>Copy WAL segments needed for consistency to the backup.</summary>
 
-                        <text>This slightly paranoid option protects against corruption or premature expiration in the WAL segment archive by storing the WAL segments directly in the backup.  PITR won't be possible without the WAL segment archive and this option also consumes more space.
+                        <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.
 
-                        Even though WAL segments will be restored with the backup, <postgres/> will ignore them if a <file>recovery.conf</file> file exists and instead use <setting>archive_command</setting> to fetch WAL segments.  Specifying <setting>type=none</setting> when restoring will not create <file>recovery.conf</file> and force <postgres/> to use the WAL segments in <path>pg_xlog</path>/<path>pg_wal</path>.  This will get the database cluster to a consistent state.</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>.</text>
 
                         <example>y</example>
                     </config-key>

diff --git a/doc/xml/release.xml b/doc/xml/release.xml
@@ -30,6 +30,12 @@
             </release-core-list>
 
             <release-doc-list>
+                <release-feature-list>
+                    <release-item>
+                        <p>Improve <br-option>archive-copy</br-option> reference documentation.</p>
+                    </release-item>
+                </release-feature-list>
+
                 <release-development-list>
                     <release-item>
                         <p>Relax permissions set by <file>release.pl</file>.</p>