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

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 26a59e6a72ba91818699b851fcaeb959b12a1f6e..67661845d09d0f8a40854619593dac443db4e4fd 100644 (file)
--- 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

diff --git a/src/openocd.c b/src/openocd.c
index 875da5a62cf0aef1a0cc48a7367e0e54fb6bfbb1..54c5eb34f7880b273bfb1d2ff67c1ace45e4e992 100644 (file)
--- a/src/openocd.c
+++ b/src/openocd.c
@@ -51,24 +51,23 @@ static const char openocd_startup_tcl[] = {
 };
 
 /* Give scripts and TELNET a way to find out what version this is */
-static int jim_version_command(Jim_Interp *interp, int argc,
-       Jim_Obj * const *argv)
+COMMAND_HANDLER(handler_version_command)
 {
-       if (argc > 2)
-               return JIM_ERR;
-       const char *str = "";
-       char *version_str;
-       version_str = OPENOCD_VERSION;
+       char *version_str = OPENOCD_VERSION;
 
-       if (argc == 2)
-               str = Jim_GetString(argv[1], NULL);
+       if (CMD_ARGC > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       if (CMD_ARGC == 1) {
+               if (strcmp("git", CMD_ARGV[0]))
+                       return ERROR_COMMAND_ARGUMENT_INVALID;
 
-       if (strcmp("git", str) == 0)
                version_str = GITVERSION;
+       }
 
-       Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
+       command_print(CMD, "%s", version_str);
 
-       return JIM_OK;
+       return ERROR_OK;
 }
 
 static int log_target_callback_event_handler(struct target *target,
@@ -194,9 +193,10 @@ COMMAND_HANDLER(handle_add_script_search_dir_command)
 static const struct command_registration openocd_command_handlers[] = {
        {
                .name = "version",
-               .jim_handler = jim_version_command,
+               .handler = handler_version_command,
                .mode = COMMAND_ANY,
                .help = "show program version",
+               .usage = "[git]",
        },
        {
                .name = "noinit",