From f78c169c3d0830bc2c762a6ad750761ecfed0afe Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Wed, 29 Nov 2017 14:43:28 +0900
Subject: [PATCH] docs: improve event notification documentation

---
 doc/event-notifications.sgml       | 12 ++++++++++++
 doc/repmgr-node-rejoin.sgml        | 10 +++++++++-
 doc/repmgr-primary-register.sgml   |  7 +++++++
 doc/repmgr-primary-unregister.sgml |  8 ++++++++
 doc/repmgr-standby-clone.sgml      |  8 ++++++++
 doc/repmgr-standby-follow.sgml     |  7 +++++++
 doc/repmgr-standby-promote.sgml    |  8 ++++++++
 doc/repmgr-standby-register.sgml   |  9 +++++++++
 doc/repmgr-standby-switchover.sgml |  9 +++++++++
 doc/repmgr-standby-unregister.sgml |  8 ++++++++
 doc/repmgr-witness-register.sgml   |  8 ++++++++
 doc/repmgr-witness-unregister.sgml |  9 +++++++++
 12 files changed, 102 insertions(+), 1 deletion(-)

diff --git a/doc/event-notifications.sgml b/doc/event-notifications.sgml
index 11bed7de..21e13f9c 100644
--- a/doc/event-notifications.sgml
+++ b/doc/event-notifications.sgml
@@ -126,6 +126,9 @@
    <listitem>
     <simpara><literal>primary_register</literal></simpara>
    </listitem>
+   <listitem>
+    <simpara><literal>primary_unregister</literal></simpara>
+   </listitem>
    <listitem>
     <simpara><literal>standby_register</literal></simpara>
    </listitem>
@@ -144,6 +147,15 @@
    <listitem>
     <simpara><literal>standby_disconnect_manual</literal></simpara>
    </listitem>
+   <listitem>
+    <simpara><literal>witness_register</literal></simpara>
+   </listitem>
+   <listitem>
+    <simpara><literal>witness_unregister</literal></simpara>
+   </listitem>
+   <listitem>
+    <simpara><literal>node_rejoin</literal></simpara>
+   </listitem>
    <listitem>
     <simpara><literal>repmgrd_start</literal></simpara>
    </listitem>
diff --git a/doc/repmgr-node-rejoin.sgml b/doc/repmgr-node-rejoin.sgml
index d81531fe..443e2948 100644
--- a/doc/repmgr-node-rejoin.sgml
+++ b/doc/repmgr-node-rejoin.sgml
@@ -45,6 +45,13 @@
     </para>
   </refsect1>
 
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>node_rejoin</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
   <refsect1>
     <title>Notes</title>
     <para>
@@ -78,7 +85,8 @@
     </para>
     <note>
       <para>
-        <command>pg_rewind</command> *requires* that either <varname>wal_log_hints</varname> is enabled, or that
+        <command>pg_rewind</command> <emphasis>requires</emphasis> that either
+        <varname>wal_log_hints</varname> is enabled, or that
         data checksums were enabled when the cluster was initialized. See the
         <ulink url="https://www.postgresql.org/docs/current/static/app-pgrewind.html"><command>pg_rewind</command> documentation</ulink> for details.
       </para>
diff --git a/doc/repmgr-primary-register.sgml b/doc/repmgr-primary-register.sgml
index 7300f6b0..26711c41 100644
--- a/doc/repmgr-primary-register.sgml
+++ b/doc/repmgr-primary-register.sgml
@@ -48,4 +48,11 @@
     </note>
   </refsect1>
 
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>primary_register</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
diff --git a/doc/repmgr-primary-unregister.sgml b/doc/repmgr-primary-unregister.sgml
index ab001cbc..24728a27 100644
--- a/doc/repmgr-primary-unregister.sgml
+++ b/doc/repmgr-primary-unregister.sgml
@@ -31,4 +31,12 @@
       <command>repmgr primary unregister</command>/
     </para>
   </refsect1>
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>primary_unregister</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
diff --git a/doc/repmgr-standby-clone.sgml b/doc/repmgr-standby-clone.sgml
index fbc6879f..5c33a98d 100644
--- a/doc/repmgr-standby-clone.sgml
+++ b/doc/repmgr-standby-clone.sgml
@@ -99,5 +99,13 @@
     </simpara>
    </note>
   </refsect1>
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_clone</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
 
diff --git a/doc/repmgr-standby-follow.sgml b/doc/repmgr-standby-follow.sgml
index adb328b1..4791614c 100644
--- a/doc/repmgr-standby-follow.sgml
+++ b/doc/repmgr-standby-follow.sgml
@@ -48,6 +48,13 @@
     </para>
   </refsect1>
 
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_follow</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
  <refsect1>
     <title>See also</title>
     <para>
diff --git a/doc/repmgr-standby-promote.sgml b/doc/repmgr-standby-promote.sgml
index 898f9690..ea4f1b5d 100644
--- a/doc/repmgr-standby-promote.sgml
+++ b/doc/repmgr-standby-promote.sgml
@@ -41,4 +41,12 @@
       DETAIL: server "node2" (ID: 2) was successfully promoted to primary</programlisting>
     </para>
   </refsect1>
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_promote</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
diff --git a/doc/repmgr-standby-register.sgml b/doc/repmgr-standby-register.sgml
index 3ef72197..e4538b48 100644
--- a/doc/repmgr-standby-register.sgml
+++ b/doc/repmgr-standby-register.sgml
@@ -74,4 +74,13 @@
     <literal>-F/--force</literal> option does not result in an incorrectly configured cluster.
    </para>
   </refsect1>
+
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_register</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
diff --git a/doc/repmgr-standby-switchover.sgml b/doc/repmgr-standby-switchover.sgml
index 5802a626..c96ea9a6 100644
--- a/doc/repmgr-standby-switchover.sgml
+++ b/doc/repmgr-standby-switchover.sgml
@@ -40,6 +40,15 @@
     </para>
   </refsect1>
 
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_promote</literal> event notification will be generated on the new primary,
+      and a <literal>node_rejoin</literal> event notification on the former primary (new standby).
+    </para>
+  </refsect1>
+
+
   <refsect1>
     <title>See also</title>
     <para>
diff --git a/doc/repmgr-standby-unregister.sgml b/doc/repmgr-standby-unregister.sgml
index 72fafd94..3784d38a 100644
--- a/doc/repmgr-standby-unregister.sgml
+++ b/doc/repmgr-standby-unregister.sgml
@@ -42,5 +42,13 @@
         repmgr standby unregister -f /etc/repmgr.conf --node-id=3</programlisting>
     </para>
   </refsect1>
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>standby_unregister</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
 
diff --git a/doc/repmgr-witness-register.sgml b/doc/repmgr-witness-register.sgml
index a82d4376..21fb610f 100644
--- a/doc/repmgr-witness-register.sgml
+++ b/doc/repmgr-witness-register.sgml
@@ -49,4 +49,12 @@
     </para>
   </refsect1>
 
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>witness_register</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>
diff --git a/doc/repmgr-witness-unregister.sgml b/doc/repmgr-witness-unregister.sgml
index 33a37aed..cc38769f 100644
--- a/doc/repmgr-witness-unregister.sgml
+++ b/doc/repmgr-witness-unregister.sgml
@@ -61,4 +61,13 @@
       <link linkend="repmgr-witness-register">repmgr witness register --force</link>.
     </para>
   </refsect1>
+
+
+  <refsect1>
+    <title>Event notifications</title>
+    <para>
+      A <literal>witness_unregister</literal> event notification will be generated.
+    </para>
+  </refsect1>
+
 </refentry>