Merging upstream version 2.1.8~rc1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 16 insertions, 2 deletions

diff --git a/include/crm/common/ipc_pacemakerd.h b/include/crm/common/ipc_pacemakerd.h
index 340f9a6..39d50ea 100644
--- a/include/crm/common/ipc_pacemakerd.h
+++ b/include/crm/common/ipc_pacemakerd.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 the Pacemaker project contributors
+ * Copyright 2020-2024 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -8,7 +8,7 @@
  */
 
 #ifndef PCMK__CRM_COMMON_IPC_PACEMAKERD__H
-#  define PCMK__CRM_COMMON_IPC_PACEMAKERD__H
+#define PCMK__CRM_COMMON_IPC_PACEMAKERD__H
 
 #include <sys/types.h>       // time_t
 #include <crm/common/ipc.h>  // pcmk_ipc_api_t
@@ -24,14 +24,22 @@ extern "C" {
  * \ingroup core
  */
 
+// NOTE: sbd (as of at least 1.5.2) uses this enum
 enum pcmk_pacemakerd_state {
     pcmk_pacemakerd_state_invalid = -1,
     pcmk_pacemakerd_state_init = 0,
     pcmk_pacemakerd_state_starting_daemons,
     pcmk_pacemakerd_state_wait_for_ping,
+
+    // NOTE: sbd (as of at least 1.5.2) uses this value
     pcmk_pacemakerd_state_running,
+
+    // NOTE: sbd (as of at least 1.5.2) uses this value
     pcmk_pacemakerd_state_shutting_down,
+
+    // NOTE: sbd (as of at least 1.5.2) uses this value
     pcmk_pacemakerd_state_shutdown_complete,
+
     pcmk_pacemakerd_state_remote,
     pcmk_pacemakerd_state_max = pcmk_pacemakerd_state_remote,
 };
@@ -39,10 +47,14 @@ enum pcmk_pacemakerd_state {
 //! Possible types of pacemakerd replies
 enum pcmk_pacemakerd_api_reply {
     pcmk_pacemakerd_reply_unknown,
+
+    // NOTE: sbd (as of at least 1.5.2) uses this value
     pcmk_pacemakerd_reply_ping,
+
     pcmk_pacemakerd_reply_shutdown,
 };
 
+// NOTE: sbd (as of at least 1.5.2) uses this type and some of its members
 /*!
  * Pacemakerd reply passed to event callback
  */
@@ -64,7 +76,9 @@ typedef struct {
     } data;
 } pcmk_pacemakerd_api_reply_t;
 
+// NOTE: sbd (as of at least 1.5.2) uses this
 int pcmk_pacemakerd_api_ping(pcmk_ipc_api_t *api, const char *ipc_name);
+
 int pcmk_pacemakerd_api_shutdown(pcmk_ipc_api_t *api, const char *ipc_name);
 
 enum pcmk_pacemakerd_state