Add a --help (-h) option to "command script add" that enables users to define a one-liner short help for their command
Also, in case they don't define any, change the default from "Run Python function <blah>" into "For more information run help <blah>"
The core issue here is that Python only allows one docstring per function, so we can't really attach both a short and a long help to the same command easily
There are alternatives but this is not a pressing enough concern to go through the motions quite yet
Fixes rdar://18322737
llvm-svn: 217795
diff --git a/lldb/test/functionalities/command_script/TestCommandScript.py b/lldb/test/functionalities/command_script/TestCommandScript.py
index 63f67b2..6efda1c 100644
--- a/lldb/test/functionalities/command_script/TestCommandScript.py
+++ b/lldb/test/functionalities/command_script/TestCommandScript.py
@@ -59,16 +59,15 @@
'A command that says hello to LLDB users'])
self.expect("help",
- substrs = ['Run Python function welcome.welcome_impl',
+ substrs = ['For more information run',
'welcome'])
self.expect("help -a",
- substrs = ['Run Python function welcome.welcome_impl',
+ substrs = ['For more information run',
'welcome'])
self.expect("help -u", matching=False,
- substrs = ['Run Python function welcome.welcome_impl',
- 'welcome'])
+ substrs = ['For more information run'])
self.runCmd("command script delete welcome");
@@ -83,11 +82,10 @@
self.expect('command script list',
substrs = ['targetname',
- 'Run Python function welcome.target_name_impl'])
+ 'For more information run'])
self.expect("help targetname",
- substrs = ['Run Python function welcome.target_name_imp',
- 'This command takes','\'raw\' input',
+ substrs = ['This command takes','\'raw\' input',
'quote stuff'])
self.expect("longwait",
@@ -112,8 +110,8 @@
substrs = ['I am running sync'])
# Test that a python command can redefine itself
- self.expect('command script add -f foobar welcome')
-
+ self.expect('command script add -f foobar welcome -h "just some help"')
+
self.runCmd("command script clear")
# Test that re-defining an existing command works