[PATCH]: 645fe0470b command: Prepend logs during command capture

[gerrit]

This is an automated email from Gerrit.

"Marek Vrbka <marek.vr...@codasip.com>" just uploaded a new patch set to 
Gerrit, which you can find at https://review.openocd.org/c/openocd/+/7902

-- gerrit

commit 645fe0470b015181bd2b271a687429f34fc11777
Author: Marek Vrbka <marek.vr...@codasip.com>
Date:   Mon Sep 18 14:32:44 2023 +0200

    command: Prepend logs during command capture
    
    Previously, if you ran a tcl command in capture like so:
    "capture { reg 0x1000 hw }"
    Such command did overwrite the tcl result if LOG_LVL_INFO or
    lower was logged during it.
    
    This patch changes it by prepending the log to the tcl result instead.
    As the tcl results should not be lost during capture.
    
    Change-Id: I37381b45e15c931ba2844d65c9d38f6ed2f6e4fd
    Signed-off-by: Marek Vrbka <marek.vr...@codasip.com>

diff --git a/doc/openocd.texi b/doc/openocd.texi
index d07188c4bc..5e092de8ad 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -12435,7 +12435,7 @@ Return information about the flash banks
 @item @b{capture} <@var{command}>
 
 Run <@var{command}> and return full log output that was produced during
-its execution. Example:
+its execution together with the command output. Example:
 
 @example
 > capture "reset init"
diff --git a/src/helper/command.c b/src/helper/command.c
index 945b890b3a..26c1757376 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -99,8 +99,7 @@ static struct log_capture_state 
*command_log_capture_start(Jim_Interp *interp)
  * The tcl return value is empty for openocd commands that provide
  * progress output.
  *
- * Therefore we set the tcl return value only if we actually
- * captured output.
+ * For other commands, we prepend the logs to the tcl return value.
  */
 static void command_log_capture_finish(struct log_capture_state *state)
 {
@@ -109,15 +108,18 @@ static void command_log_capture_finish(struct 
log_capture_state *state)
 
        log_remove_callback(tcl_output, state);
 
-       int length;
-       Jim_GetString(state->output, &length);
+       int loglen;
+       const char *log_result = Jim_GetString(state->output, &loglen);
 
-       if (length > 0)
-               Jim_SetResult(state->interp, state->output);
-       else {
-               /* No output captured, use tcl return value (which could
-                * be empty too). */
-       }
+       // Just in case the log doesn't end with a newline, we add it
+       if (loglen != 0 && log_result[loglen - 1] != '\n')
+               Jim_AppendString(state->interp, state->output, "\n", 1);
+
+       int reslen;
+       const char *cmd_result = Jim_GetString(Jim_GetResult(state->interp), 
&reslen);
+       Jim_AppendString(state->interp, state->output, cmd_result, reslen);
+
+       Jim_SetResult(state->interp, state->output);
        Jim_DecrRefCount(state->interp, state->output);
 
        free(state);
@@ -691,8 +693,8 @@ COMMAND_HANDLER(handle_echo)
        return ERROR_OK;
 }
 
-/* Capture progress output and return as tcl return value. If the
- * progress output was empty, return tcl return value.
+/* Return both the progress output (LOG_INFO and higher)
+ * and the tcl return value of a command.
  */
 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {

--