diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2022-12-18 19:12:35 +0100 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2023-03-25 18:10:54 +0000 |
| commit | 880ae3f07744a09e267bde00cf405c85a6f10482 (patch) | |
| tree | 9d13d270986999732fe2d82546c3c1601761bba7 /doc/openocd.texi | |
| parent | 842a12f4caf307e756045c14011c402a20da30b6 (diff) | |
| download | riscv-openocd-880ae3f07744a09e267bde00cf405c85a6f10482.zip riscv-openocd-880ae3f07744a09e267bde00cf405c85a6f10482.tar.gz riscv-openocd-880ae3f07744a09e267bde00cf405c85a6f10482.tar.bz2 | |
openocd: rewrite command 'version' as COMMAND_HANDLER
Trivial change.
While there:
- add the mandatory 'usage' field;
- document the optional parameter 'git';
- reword the documentation.
Change-Id: I6be4d4423128fa026a62e2ef355f77b69d50397e
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/7488
Tested-by: jenkins
Diffstat (limited to 'doc/openocd.texi')
| -rw-r--r-- | doc/openocd.texi | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index 26a59e6..6766184 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -9101,8 +9101,10 @@ format. Optional @option{start} and @option{end} parameters allow to limit the address range. @end deffn -@deffn {Command} {version} -Displays a string identifying the version of this OpenOCD server. +@deffn {Command} {version} [git] +Returns a string identifying the version of this OpenOCD server. +With option @option{git}, it returns the git version obtained at compile time +through ``git describe''. @end deffn @deffn {Command} {virt2phys} virtual_address |