]> git.gag.com Git - fw/openocd/commitdiff
doc/openocd.texi: Document usage command
authorYasushi SHOJI <yashi@spacecubics.com>
Sun, 21 Nov 2021 23:21:50 +0000 (08:21 +0900)
committerAntonio Borneo <borneo.antonio@gmail.com>
Fri, 3 Dec 2021 21:55:46 +0000 (21:55 +0000)
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>
doc/openocd.texi

index 2c612e0a37752ed57eeca242e60596576abde785..e0234e577858bb4cd14ffa7b59675864c2e85014 100644 (file)
@@ -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.