Merge pull request #1404 from nicholasyang2022/ui-context-ignore-requ…

…iremnt-help [crmsh-4.6] Dev: ui_context: ignore requirements when option --help is specified
ClusterLabs · Apr 25, 2024 · c75d131 · c75d131
2 parents 11e262d + 47a9ba0
commit c75d131
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 8 deletions.
diff --git a/crmsh/constants.py b/crmsh/constants.py
@@ -512,5 +512,6 @@
 RSC_ROLE_UNPROMOTED_LEGACY = "Slave"
 PCMK_VERSION_DEFAULT = "2.0.0"
 
-NON_FUNCTIONAL_COMMANDS = ('help', 'cd', 'ls', 'quit', 'up')
+NON_FUNCTIONAL_COMMANDS = {'help', 'cd', 'ls', 'quit', 'up'}
+NON_FUNCTIONAL_OPTIONS = {'--help', '--help-without-redirect'}
 # vim:ts=4:sw=4:et:
diff --git a/crmsh/ui_context.py b/crmsh/ui_context.py
@@ -82,7 +82,8 @@ def run(self, line):
                     cmd = True
                     break
             if cmd:
-                if self.command_name not in constants.NON_FUNCTIONAL_COMMANDS:
+                if self.command_name not in constants.NON_FUNCTIONAL_COMMANDS\
+                        and all(arg not in constants.NON_FUNCTIONAL_OPTIONS for arg in self.command_args):
                     entry = self.current_level()
                     if 'requires' in dir(entry) and not entry.requires():
                         self.fatal_error("Missing requirements")

diff --git a/doc/toolchain/bin/adocxt b/doc/toolchain/bin/adocxt
@@ -13,8 +13,6 @@ RE_SECTION_TITLE = re.compile('^=')
 RE_FROM_CODE_OR_SECTION_TITLE=re.compile(r'^(?:\[\[([^,]+),[^,]*,From Code]]$|=)')
 
 TAG_EXCLUDES = {
-    'cmdhelp_node_online',
-    'cmdhelp_node_standby',
     'cmdhelp_root_report',
 }
 

diff --git a/doc/website-v1/man-4.6.adoc b/doc/website-v1/man-4.6.adoc
@@ -2479,9 +2479,20 @@ maintenance [<node>]
 
 [[cmdhelp_node_online,set node online,From Code]]
 ==== `online`
-See "crm node help online" or "crm node online --help"
+Usage:
+
+ online [--all | <node>... ]
+
+Specify node(s) on which to online node. If no nodes are specified, online node on the local node. If --all is specified, online node on all nodes.
+
+Options:
+
+* `+++-h, --help+++`: Show this help message
+
+* `+++--all+++`: To online node on all nodes
+
+
 
-[[cmdhelp_node_ready,put node into ready mode]]
 ==== `ready`
 
 Set the node's maintenance status to `off`. The node should be
@@ -2523,9 +2534,22 @@ show [<node>]
 
 [[cmdhelp_node_standby,put node into standby,From Code]]
 ==== `standby`
-See "crm node help standby" or "crm node standby --help"
+Usage:
+
+ standby [--all | <node>... ] [lifetime]
+
+Specify node(s) on which to standby node. If no nodes are specified, standby node on the local node. If --all is specified, standby node on all nodes.
+
+Additionally, you may specify a lifetime for the standby---if set to "reboot", the node will be back online once it reboots. "forever" will keep the node in standby after reboot. The life time defaults to "forever".
+
+Options:
+
+* `+++-h, --help+++`: Show this help message
+
+* `+++--all+++`: To standby node on all nodes
+
+
 
-[[cmdhelp_node_status-attr,manage status attributes]]
 ==== `status-attr`
 
 Edit node attributes which are in the CIB status section, i.e.,