aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYasushi SHOJI <yashi@spacecubics.com>2021-11-22 08:18:22 +0900
committerAntonio Borneo <borneo.antonio@gmail.com>2021-12-03 21:55:02 +0000
commit39197e3e5345964686b7d5e2c3fce3d63563a7e9 (patch)
treeaa67cc5c45820109cc1eb0206a5a17d87dd4d540 /doc
parent6179d9f848a78908e9ca245c775a510ed1b6ac17 (diff)
downloadriscv-openocd-39197e3e5345964686b7d5e2c3fce3d63563a7e9.zip
riscv-openocd-39197e3e5345964686b7d5e2c3fce3d63563a7e9.tar.gz
riscv-openocd-39197e3e5345964686b7d5e2c3fce3d63563a7e9.tar.bz2
doc/openocd.texi: Document add_help_text and add_usage_text
Document add_help_text and add_usage_text under Genral Commands -> Misc Commands. The text are taken from command's help strings. Change-Id: I2bbbee8e5faa8d9654227c304e0528f5144275e8 Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com> Reviewed-on: https://review.openocd.org/c/openocd/+/6734 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 4923a87..2c612e0 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -8739,6 +8739,14 @@ Requests the current target to map the specified @var{virtual_address}
to its corresponding physical address, and displays the result.
@end deffn
+@deffn {Command} {add_help_text} 'command_name' 'help-string'
+Add or replace help text on the given @var{command_name}.
+@end deffn
+
+@deffn {Command} {add_usage_text} 'command_name' 'help-string'
+Add or replace usage text on the given @var{command_name}.
+@end deffn
+
@node Architecture and Core Commands
@chapter Architecture and Core Commands
@cindex Architecture Specific Commands