aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYasushi SHOJI <yashi@spacecubics.com>2021-11-22 08:21:50 +0900
committerAntonio Borneo <borneo.antonio@gmail.com>2021-12-03 21:55:46 +0000
commit15110b2b5bf3459d038e6142d151c3856760e387 (patch)
tree8604f66c4d84d44386a0ca9d9b37de051fe01ccf /doc
parent39197e3e5345964686b7d5e2c3fce3d63563a7e9 (diff)
downloadriscv-openocd-15110b2b5bf3459d038e6142d151c3856760e387.zip
riscv-openocd-15110b2b5bf3459d038e6142d151c3856760e387.tar.gz
riscv-openocd-15110b2b5bf3459d038e6142d151c3856760e387.tar.bz2
doc/openocd.texi: Document usage command
Document usage command under General Commands -> Server Commands. The text is taken from the command's help string. Change-Id: I957cb46cca98181c3c5e676228c5c103e47bb655 Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com> Reviewed-on: https://review.openocd.org/c/openocd/+/6735 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 2c612e0..e0234e5 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -8250,6 +8250,13 @@ In most cases, no such restriction is listed; this indicates commands
which are only available after the configuration stage has completed.
@end deffn
+@deffn {Command} {usage} [string]
+With no parameters, prints usage text for all commands. Otherwise,
+prints all usage text of which command, help text, and usage text
+containing @var{string}.
+Not every command provides helptext.
+@end deffn
+
@deffn {Command} {sleep} msec [@option{busy}]
Wait for at least @var{msec} milliseconds before resuming.
If @option{busy} is passed, busy-wait instead of sleeping.