From 37407f4a7b711896ff5fdc1dd98740ebd013cb2c Mon Sep 17 00:00:00 2001 From: Yasushi SHOJI Date: Mon, 22 Nov 2021 08:23:32 +0900 Subject: [PATCH] doc/openocd.texi: Document command mode command Document "command mode" command Server Configuration -> Configuration Stage. The text is taken from command's help string. In addition to the help string, this commit explain the words mismatch, the doc uses "stage" but the command and source code uses "mode" to describe the same thing. Change-Id: I1d5fc8c64a3a0b07ea8430bf016bcbd54e52da1c Signed-off-by: Yasushi SHOJI Reviewed-on: https://review.openocd.org/c/openocd/+/6736 Tested-by: jenkins Reviewed-by: Antonio Borneo --- doc/openocd.texi | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/openocd.texi b/doc/openocd.texi index cceba79260..fa1b8da05a 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -2040,6 +2040,19 @@ may access or activate TAPs. After it leaves this stage, configuration commands may no longer be issued. +@deffn {Command} {command mode} [command_name] +Returns the command modes allowed by a command: 'any', 'config', or +'exec'. If no command is specified, returns the current command +mode. Returns 'unknown' if an unknown command is given. Command can be +multiple tokens. (command valid any time) + +In this document, the modes are described as stages, 'config' and +'exec' mode correspond configuration stage and run stage. 'any' means +the command can be executed in either +stages. @xref{configurationstage,,Configuration Stage}, and +@xref{enteringtherunstage,,Entering the Run Stage}. +@end deffn + @anchor{enteringtherunstage} @section Entering the Run Stage -- 2.30.2