public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed

From: Junio C Hamano <gitster@pobox•com>
To: David Aguilar <davvid@gmail•com>
Cc: git@vger•kernel.org, Adri Farr <14farresa@gmail•com>
Subject: Re: [PATCH] difftool: honor --trust-exit-code for builtin tools
Date: Fri, 14 Nov 2014 13:51:39 -0800	[thread overview]
Message-ID: <xmqqy4rd1mdw.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1416000835-79274-1-git-send-email-davvid@gmail.com> (David Aguilar's message of "Fri, 14 Nov 2014 13:33:55 -0800")

David Aguilar <davvid@gmail•com> writes:

> run_merge_tool() was not setting $status, which prevented the
> exit code for builtin tools from being forwarded to the caller.
>
> Capture the exit status and add a test to guarantee the behavior.
>
> Reported-by: Adria Farres <14farresa@gmail•com>
> Signed-off-by: David Aguilar <davvid@gmail•com>
> ---
>  git-mergetool--lib.sh | 1 +
>  t/t7800-difftool.sh   | 5 +++++
>  2 files changed, 6 insertions(+)
>
> diff --git a/git-mergetool--lib.sh b/git-mergetool--lib.sh
> index a40d3df..2b66351 100644
> --- a/git-mergetool--lib.sh
> +++ b/git-mergetool--lib.sh
> @@ -221,6 +221,7 @@ run_merge_tool () {
>  	else
>  		run_diff_cmd "$1"
>  	fi
> +	status=$?
>  	return $status
>  }

Thanks for a quick turn-around.  As a hot-fix for what is already in
-rc I am fine with this fix but the patch makes me wonder if $status
as a global shell variable has any significance.

I see that this shell function in its early part does this:

	status=0
        setup_tool "$1" || return 1

which means that the caller of this function, instead of checking
what is returned as the return value of the function like:

	if run_merge_tool ...
        then
		...

relies on the value of $status in its later part of the code like:

	run_merge_tool ...
	...
	if test "$status" = 0
	then
		...

then we are already in trouble.  And the latter form, if we had such
a flow in the code, is simply a bad taste.

A cleaner fix might be to get rid of the extra $status variable from
this function and let the function return the result of its last
command, either run_merge_cmd or run_diff_cmd, by either explicitly
having "return $?" at the end, or not having that "return $status"
line.  But that relies on us not having any caller that relies on
the $status carried as a global variable around, so it will be more
work to convince ourselves that such a fix is correctly done.  From
my cursory look, what I suggested above should be safe and correct,
but I do not want to risk an unnecessary and silly breakage this
late in the cycle.

So I'll queue this patch as-is for upcoming 2.2, but I think we
would want to revisit this issue after the release is done.

next prev parent reply	other threads:[~2014-11-14 21:51 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-14 21:33 [PATCH] difftool: honor --trust-exit-code for builtin tools David Aguilar
2014-11-14 21:51 ` Junio C Hamano [this message]
2014-11-14 21:57   ` David Aguilar
2014-11-16  1:51   ` Mikael Magnusson
2014-11-16  2:36     ` David Aguilar
2014-11-16 18:11     ` Junio C Hamano
2014-11-17 22:15       ` Aaron Schrab
2014-11-16  8:18 ` [PATCH] " Andreas Schwab
  -- strict thread matches above, loose matches on Subject: below --
2014-11-15  0:27 David Aguilar
2014-11-15 14:22 ` Adri Farr

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=xmqqy4rd1mdw.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=14farresa@gmail$(echo .)com \
    --cc=davvid@gmail$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    /path/to/YOUR_REPLY

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox