doc/openocd.texi: Document add_help_text and add_usage_text
authorYasushi SHOJI <yashi@spacecubics.com>
Sun, 21 Nov 2021 23:18:22 +0000 (08:18 +0900)
committerAntonio Borneo <borneo.antonio@gmail.com>
Fri, 3 Dec 2021 21:55:02 +0000 (21:55 +0000)
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>
doc/openocd.texi

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