Document maximum version for auto-stop option.

pgbackrest · Oct 3, 2019 · 887ec97 · 887ec97
1 parent 008ec6b
commit 887ec97
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/doc/xml/reference.xml b/doc/xml/reference.xml
@@ -606,6 +606,8 @@
 
                         This feature relies on pg_is_in_backup() so only works on <postgres/> >= <id>9.3</id>.
 
+                        This feature is not supported for <postgres/> >= <id>9.6</id> since backups are run in non-exclusive mode.
+
                         The setting is disabled by default because it assumes that <backrest/> is the only process doing exclusive online backups.  It depends on an advisory lock that only <backrest/> sets so it may abort other processes that do exclusive online backups.  Note that <cmd>base_backup</cmd> and <cmd>pg_dump</cmd> are safe to use with this setting because they do not call <code>pg_start_backup()</code> so are not exclusive.</text>
 
                         <example>y</example>

diff --git a/doc/xml/release.xml b/doc/xml/release.xml
@@ -13,6 +13,18 @@
 
     <release-list>
         <release date="XXXX-XX-XX" version="2.19dev" title="UNDER DEVELOPMENT">
+            <release-doc-list>
+                <release-improvement-list>
+                    <release-item>
+                        <release-item-contributor-list>
+                            <release-item-contributor id="brad.nicholson"/>
+                        </release-item-contributor-list>
+
+                        <p>Document maximum version for <br-option>auto-stop</br-option> option.</p>
+                    </release-item>
+                </release-improvement-list>
+            </release-doc-list>
+
         </release>
 
         <release date="2019-10-01" version="2.18" title="PostgreSQL 12 Support">

diff --git a/src/config/define.auto.c b/src/config/define.auto.c
@@ -4382,6 +4382,8 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
             "\n"
             "This feature relies on pg_is_in_backup() so only works on PostgreSQL >= 9.3.\n"
             "\n"
+            "This feature is not supported for PostgreSQL >= 9.6 since backups are run in non-exclusive mode.\n"
+            "\n"
             "The setting is disabled by default because it assumes that pgBackRest is the only process doing exclusive online "
                 "backups. It depends on an advisory lock that only pgBackRest sets so it may abort other processes that do "
                 "exclusive online backups. Note that base_backup and pg_dump are safe to use with this setting because they do not "