Doc: various: update some COMPAT comments

ClusterLabs · Jul 29, 2024 · ad47002 · ad47002
1 parent 624bf99
commit ad47002
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 14 deletions.
diff --git a/daemons/based/pacemaker-based.c b/daemons/based/pacemaker-based.c
@@ -126,6 +126,8 @@ setup_stand_alone(GError **error)
 
 /* @COMPAT Deprecated since 2.1.8. Use pcmk_list_cluster_options() or
  * crm_attribute --list-options=cluster instead of querying daemon metadata.
+ *
+ * NOTE: pcs (as of at least 0.11.8) uses this
  */
 static int
 based_metadata(pcmk__output_t *out)

diff --git a/daemons/controld/pacemaker-controld.c b/daemons/controld/pacemaker-controld.c
@@ -48,6 +48,8 @@ static pcmk__supported_format_t formats[] = {
 
 /* @COMPAT Deprecated since 2.1.8. Use pcmk_list_cluster_options() or
  * crm_attribute --list-options=cluster instead of querying daemon metadata.
+ *
+ * NOTE: pcs (as of at least 0.11.8) uses this
  */
 static int
 controld_metadata(pcmk__output_t *out)

diff --git a/daemons/fenced/pacemaker-fenced.c b/daemons/fenced/pacemaker-fenced.c
@@ -485,6 +485,8 @@ st_peer_update_callback(enum pcmk__node_update type, pcmk__node_status_t *node,
 
 /* @COMPAT Deprecated since 2.1.8. Use pcmk_list_fence_attrs() or
  * crm_resource --list-options=fencing instead of querying daemon metadata.
+ *
+ * NOTE: pcs (as of at least 0.11.8) uses this
  */
 static int
 fencer_metadata(void)

diff --git a/daemons/schedulerd/pacemaker-schedulerd.c b/daemons/schedulerd/pacemaker-schedulerd.c
@@ -48,6 +48,8 @@ void pengine_shutdown(int nsig);
 
 /* @COMPAT Deprecated since 2.1.8. Use pcmk_list_cluster_options() or
  * crm_attribute --list-options=cluster instead of querying daemon metadata.
+ *
+ * NOTE: pcs (as of at least 0.11.8) uses this
  */
 static int
 scheduler_metadata(pcmk__output_t *out)

diff --git a/include/crm/cluster/internal.h b/include/crm/cluster/internal.h
@@ -27,11 +27,8 @@
 extern "C" {
 #endif
 
+// @TODO Replace this with a pcmk__node_status_flags value
 enum crm_proc_flag {
-    /* @COMPAT When pcmk__node_status_t:processes is made internal, we can merge
-     * this into node flags or turn it into a boolean. Until then, in theory
-     * something could depend on these particular numeric values.
-     */
     crm_proc_none       = 0x00000001,
 
     // Cluster layers

diff --git a/tools/crm_mon.c b/tools/crm_mon.c
@@ -722,16 +722,9 @@ static GOptionEntry display_entries[] = {
 };
 
 static GOptionEntry deprecated_entries[] = {
-    /* @COMPAT At least the following resource agents use --as-xml at time of
-     * writing:
-     * * galera
-     * * pgsql
-     * * rabbitmq-cluster
-     * * redis
-     *
-     * Removing this option must wait until those are updated and we no longer
-     * support building on any platforms that ship the older agents in stock
-     * packages.
+    /* @COMPAT resource-agents <4.15.0 uses --as-xml, so removing this option
+     * must wait until we no longer support building on any platforms that ship
+     * the older agents.
      */
     { "as-xml", 'X', G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK, as_xml_cb,
       "Write cluster status as XML to stdout. This will enable one-shot mode.\n"