diff --git a/doc/xml/release.xml b/doc/xml/release.xml index d2ccb1a99..f4cada8d2 100644 --- a/doc/xml/release.xml +++ b/doc/xml/release.xml @@ -137,6 +137,18 @@ + + + + + + + +

Added archive-timeout option documentation to the user guide.

+
+
+
+ diff --git a/doc/xml/user-guide.xml b/doc/xml/user-guide.xml index def3e533a..4bcdd6e4c 100644 --- a/doc/xml/user-guide.xml +++ b/doc/xml/user-guide.xml @@ -400,6 +400,8 @@ {[db-cluster-wait]} + +

When archiving a WAL segment is expected to take more than 60 seconds (the default) then the archive-timeout option should be increased.

@@ -690,6 +692,13 @@

Note that pg_dump and pg_base_backup do not take online backups so are not affected. It is safe to run them in conjunction with .

+ + +
+ Archive Timeout + +

During an online backup, waits for WAL segments that are required to make the backup consistent to be archived. This wait time is governed by the archive-timeout option which defaults to 60 seconds. If archiving an individual segment is known to take longer, then this option should be increased.

+