Fix "Current State" to "Reported State", and a docs cross-ref. (#820)

hapostgres · Oct 21, 2021 · 746afb2 · 746afb2
1 parent 382009e
commit 746afb2
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -18,7 +18,7 @@ health checks and the retry policy.
 See the :ref:`configuration` part for more information about how to setup
 the different delays and timeouts that are involved in the decision making.
 
-See also :ref:`pg_autoctl watch` to have a dashboard that helps
+See also :ref:`pg_autoctl_watch` to have a dashboard that helps
 understanding the system and what's going on in the moment.
 
 The secondary is blocked in the CATCHING_UP state, what should I do?

diff --git a/docs/ref/pg_autoctl_show_state.rst b/docs/ref/pg_autoctl_show_state.rst
@@ -111,10 +111,10 @@ The ``pg_autoctl show state`` output includes the following columns:
 	to connect to this node, and ``?`` when the monitor didn't connect to
 	the node yet.
 
-  - Current State
+  - Reported State
 
-	The current FSM state as reported to the monitor by the pg_autoctl
-	process running on the Postgres node.
+	The latest reported FSM state, as reported to the monitor by the
+	pg_autoctl process running on the Postgres node.
 
   - Assigned State
 
@@ -130,14 +130,14 @@ Examples
 ::
 
    $ pg_autoctl show state
-    Name |  Node |      Host:Port |       TLI: LSN |   Connection |       Current State |      Assigned State
+    Name |  Node |      Host:Port |       TLI: LSN |   Connection |      Reported State |      Assigned State
    ------+-------+----------------+----------------+--------------+---------------------+--------------------
    node1 |     1 | localhost:5501 |   1: 0/4000678 |   read-write |             primary |             primary
    node2 |     2 | localhost:5502 |   1: 0/4000678 |    read-only |           secondary |           secondary
    node3 |     3 | localhost:5503 |   1: 0/4000678 |    read-only |           secondary |           secondary
 
    $ pg_autoctl show state --local
-    Name |  Node |      Host:Port |       TLI: LSN |   Connection |       Current State |      Assigned State
+    Name |  Node |      Host:Port |       TLI: LSN |   Connection |      Reported State |      Assigned State
    ------+-------+----------------+----------------+--------------+---------------------+--------------------
    node1 |     1 | localhost:5501 |   1: 0/4000678 | read-write ? |             primary |             primary
 

diff --git a/src/bin/pg_autoctl/nodestate_utils.c b/src/bin/pg_autoctl/nodestate_utils.c
@@ -209,7 +209,7 @@ nodestatePrintHeader(NodeAddressHeaders *headers)
 			headers->maxHostSize, "Host:Port",
 			headers->maxLSNSize, "TLI: LSN",
 			headers->maxHealthSize, "Connection",
-			headers->maxStateSize, "Current State",
+			headers->maxStateSize, "Reported State",
 			headers->maxStateSize, "Assigned State");
 
 	fformat(stdout, "%*s-+-%*s-+-%*s-+-%*s-+-%*s-+-%*s-+-%*s\n",