git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ian Wienand <iwienand@redhat.com>
To: git@vger.kernel.org
Cc: Ian Wienand <iwienand@redhat.com>
Subject: [PATCH v4 3/3] run-command: show prepared command
Date: Fri, 24 May 2024 17:32:44 +1000	[thread overview]
Message-ID: <20240524073411.1355958-3-iwienand@redhat.com> (raw)
In-Reply-To: <20240524073411.1355958-1-iwienand@redhat.com>

This adds a trace point in prepare_cmd (for windows,
prepare_shell_cmd), so we can see the actual command being run without
having to resort to strace/code inspection.

e.g. "test = !echo" when run under GIT_TRACE will show:

 $ GIT_TRACE=1 git test hello
 10:58:56.877234 git.c:755               trace: exec: git-test hello
 10:58:56.877382 run-command.c:657       trace: run_command: git-test hello
 10:58:56.878655 run-command.c:657       trace: run_command: echo hello
 10:58:56.878747 run-command.c:437       trace: prepare_cmd: /usr/bin/echo hello
 hello

A "split" alias, e.g. test = "!echo $*" will show the shell wrapping
and appending of "$@".

 $ GIT_TRACE=1 git test hello
 11:00:45.959420 git.c:755               trace: exec: git-test hello
 11:00:45.959737 run-command.c:657       trace: run_command: git-test hello
 11:00:45.961424 run-command.c:657       trace: run_command: 'echo $*' hello
 11:00:45.961528 run-command.c:437       trace: prepare_cmd: /bin/sh -c 'echo $* "$@"' 'echo $*' hello
 hello hello

Prior changes have made the documentation around the internals of the
alias command execution clearer, but I have still found this detailed
view of the aliased command being run helpful for debugging purposes.

A test case is added.  This simply looks for the trace point output;
the details change depending on platform -- the important thing is
that we have a verbose log point, not so much the details of what
happens on each platform.

Signed-off-by: Ian Wienand <iwienand@redhat.com>
---
 run-command.c    | 2 ++
 t/t0014-alias.sh | 6 ++++++
 2 files changed, 8 insertions(+)

diff --git a/run-command.c b/run-command.c
index 1b821042b4..13e35fb76e 100644
--- a/run-command.c
+++ b/run-command.c
@@ -296,6 +296,7 @@ static const char **prepare_shell_cmd(struct strvec *out, const char **argv)
 	}
 
 	strvec_pushv(out, argv);
+	trace_argv_printf(&out->v[1], "trace: prepare_cmd:");
 	return out->v;
 }
 
@@ -435,6 +436,7 @@ static int prepare_cmd(struct strvec *out, const struct child_process *cmd)
 		}
 	}
 
+	trace_argv_printf(&out->v[1], "trace: prepare_cmd:");
 	return 0;
 }
 
diff --git a/t/t0014-alias.sh b/t/t0014-alias.sh
index 95568342be..b7affbe93a 100755
--- a/t/t0014-alias.sh
+++ b/t/t0014-alias.sh
@@ -44,4 +44,10 @@ test_expect_success 'run-command formats empty args properly' '
     test_cmp expect actual
 '
 
+test_expect_success 'tracing a shell alias with arguments shows trace of prepared command' '
+	git config alias.echo "!echo \$*" &&
+	env GIT_TRACE=1 git echo argument 2>output &&
+	test_grep "^trace: prepare_cmd:.*" output
+'
+
 test_done
-- 
2.45.1


  parent reply	other threads:[~2024-05-24  7:34 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-22  2:41 [PATCH] alias: document caveats and add trace of prepared command Ian Wienand
2024-05-22  3:29 ` Eric Sunshine
2024-05-22 16:07 ` Junio C Hamano
2024-05-23  0:38   ` Ian Wienand
2024-05-23  4:20 ` [PATCH v2 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-23  4:20   ` [PATCH v2 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-23  4:20   ` [PATCH v2 3/3] run-command: show prepared command Ian Wienand
2024-05-23  4:27   ` [PATCH v2 1/3] Documentation: alias: rework notes into points Eric Sunshine
2024-05-23  4:39     ` Ian Wienand
2024-05-23  4:37   ` [PATCH v3 " Ian Wienand
2024-05-23  4:37     ` [PATCH v3 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-23  4:37     ` [PATCH v3 3/3] run-command: show prepared command Ian Wienand
2024-05-23 15:29       ` Junio C Hamano
2024-05-23 23:40         ` Junio C Hamano
2024-05-24  6:09           ` Junio C Hamano
2024-05-24  7:18             ` Ian Wienand
2024-05-24 15:33               ` Junio C Hamano
2024-05-24  0:43         ` Ian Wienand
2024-05-24 17:50           ` Junio C Hamano
2024-05-25  1:13             ` Ian Wienand
2024-05-23 15:14     ` [PATCH v3 1/3] Documentation: alias: rework notes into points Junio C Hamano
2024-05-24  7:32     ` [PATCH v4 " Ian Wienand
2024-05-24  7:32       ` [PATCH v4 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-24  7:32       ` Ian Wienand [this message]
2024-05-24 19:16         ` [PATCH v4 3/3] run-command: show prepared command Junio C Hamano
2024-05-24 19:58           ` Junio C Hamano
2024-05-25  1:14           ` Ian Wienand
2024-05-25  1:20       ` [PATCH v5 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-25  1:20         ` [PATCH v5 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-25  1:20         ` [PATCH v5 3/3] run-command: show prepared command Ian Wienand
2024-05-25  5:44           ` Junio C Hamano
2024-05-25  6:06           ` Junio C Hamano
2024-05-25 23:49             ` Ian Wienand
2024-05-25 23:44         ` [PATCH v6 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-25 23:44           ` [PATCH v6 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-26 23:26             ` Junio C Hamano
2024-05-27  0:22               ` Ian Wienand
2024-05-25 23:44           ` [PATCH v6 3/3] run-command: show prepared command Ian Wienand
2024-05-26 16:20             ` Junio C Hamano
2024-05-27  0:30           ` [PATCH v7 1/3] Documentation: alias: rework notes into points Ian Wienand
2024-05-27  0:30             ` [PATCH v7 2/3] Documentation: alias: add notes on shell expansion Ian Wienand
2024-05-27 17:48               ` Junio C Hamano
2024-05-27  0:30             ` [PATCH v7 3/3] run-command: show prepared command Ian Wienand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240524073411.1355958-3-iwienand@redhat.com \
    --to=iwienand@redhat.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).