From 146654bf0e8bde984de3479e16c3c74181ebac4a Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Fri, 4 Sep 2020 15:10:54 +0900
Subject: [PATCH] Clarify code comment

---
 repmgr-client.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/repmgr-client.c b/repmgr-client.c
index 4a393ce4..8de73bd4 100644
--- a/repmgr-client.c
+++ b/repmgr-client.c
@@ -3616,8 +3616,12 @@ can_use_pg_rewind(PGconn *conn, const char *data_directory, PQExpBufferData *rea
 }
 
 
-// provided connection should be for the normal repmgr user
-// upstream_node_record may be NULL or initialised to default values
+/*
+ * NOTE:
+ *  - the provided connection should be for the normal repmgr user
+ *  - if upstream_node_record is not NULL, its "repluser" entry, if
+ *    set, will be used as the fallback replication user
+ */
 bool
 create_replication_slot(PGconn *conn, char *slot_name, t_node_info *upstream_node_record, PQExpBufferData *error_msg)
 {