diff mbox series

[v2] commit: restore --edit when combined with --fixup

Message ID pull.1014.v2.git.1628725421868.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v2] commit: restore --edit when combined with --fixup | expand

Commit Message

Joel Klinghed Aug. 11, 2021, 11:43 p.m. UTC
From: Joel Klinghed <the_jk@spawned.biz>

Recent changes to --fixup, adding amend suboption, caused the
--edit flag to be ignored as use_editor was always set to zero.

Restore edit_flag having higher priority than fixup_message when
deciding the value of use_editor by only changing the default
if edit_flag is not set.

Signed-off-by: Joel Klinghed <the_jk@spawned.biz>
---
    commit: restore --edit when combined with --fixup
    
    Recent changes to --fixup, adding amend suboption, caused the --edit
    flag to be ignored as use_editor was always set to zero.
    
    Restore edit_flag having higher priority than fixup_message when
    deciding the value of use_editor by only changing the default if
    edit_flag is not set.
    
    Changes since v1: Added test verifying that --fixup --edit brings up
    editor.
    
    Signed-off-by: Joel Klinghed the_jk@spawned.biz

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1014%2Fthejk%2Ffixup_edit-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1014/thejk/fixup_edit-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1014

Range-diff vs v1:

 1:  b3e44c6ccde ! 1:  0ee926d4149 commit: restore --edit when combined with --fixup
     @@ builtin/commit.c: static int parse_and_validate_options(int argc, const char *ar
       		}
       	}
       
     +
     + ## t/t7500-commit-template-squash-signoff.sh ##
     +@@ t/t7500-commit-template-squash-signoff.sh: test_expect_success 'commit --fixup -m"something" -m"extra"' '
     + 
     + extra"
     + '
     ++test_expect_success 'commit --fixup --edit' '
     ++	commit_for_rebase_autosquash_setup &&
     ++	cat >e-append <<-\EOF &&
     ++	#!/bin/sh
     ++	sed -e "2a\\
     ++something\\
     ++extra" <"$1" >"$1-"
     ++	mv "$1-" "$1"
     ++	EOF
     ++	chmod 755 e-append &&
     ++	EDITOR="./e-append" git commit --fixup HEAD~1 --edit &&
     ++	commit_msg_is "fixup! target message subject linesomething
     ++extra"
     ++'
     ++
     + get_commit_msg () {
     + 	rev="$1" &&
     + 	git log -1 --pretty=format:"%B" "$rev"


 builtin/commit.c                          |  3 ++-
 t/t7500-commit-template-squash-signoff.sh | 15 +++++++++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)


base-commit: ebf3c04b262aa27fbb97f8a0156c2347fecafafb

Comments

Junio C Hamano Aug. 12, 2021, 5:21 a.m. UTC | #1
"Joel Klinghed via GitGitGadget" <gitgitgadget@gmail.com> writes:

> diff --git a/builtin/commit.c b/builtin/commit.c
> index 190d215d43b..4c5286840c5 100644
> --- a/builtin/commit.c
> +++ b/builtin/commit.c
> @@ -1333,7 +1333,8 @@ static int parse_and_validate_options(int argc, const char *argv[],
>  		} else {
>  			fixup_commit = fixup_message;
>  			fixup_prefix = "fixup";
> -			use_editor = 0;
> +			if (0 > edit_flag)

Writing this as

			if (edit_flag < 0)

makes it far easier to immediately see that we are talking about a
nagetive edit_flag.

> +				use_editor = 0;
>  		}
>  	}
>  
> diff --git a/t/t7500-commit-template-squash-signoff.sh b/t/t7500-commit-template-squash-signoff.sh
> index 7d02f79c0de..d71c7812180 100755
> --- a/t/t7500-commit-template-squash-signoff.sh
> +++ b/t/t7500-commit-template-squash-signoff.sh
> @@ -281,6 +281,21 @@ test_expect_success 'commit --fixup -m"something" -m"extra"' '
>  
>  extra"
>  '
> +test_expect_success 'commit --fixup --edit' '
> +	commit_for_rebase_autosquash_setup &&

> +	cat >e-append <<-\EOF &&
> +	#!/bin/sh
> +	sed -e "2a\\
> +something\\
> +extra" <"$1" >"$1-"
> +	mv "$1-" "$1"
> +	EOF
> +	chmod 755 e-append &&

Use write_script helper from test-lib-functions.sh here and lose the
hardcoded reference to /bin/sh.

> +	EDITOR="./e-append" git commit --fixup HEAD~1 --edit &&
> +	commit_msg_is "fixup! target message subject linesomething
> +extra"
> +'


Thanks.
Joel Klinghed Aug. 12, 2021, 7:42 a.m. UTC | #2
On Thu, Aug 12, 2021, at 07:21, Junio C Hamano wrote:
> "Joel Klinghed via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
> > diff --git a/builtin/commit.c b/builtin/commit.c
> > index 190d215d43b..4c5286840c5 100644
> > --- a/builtin/commit.c
> > +++ b/builtin/commit.c
> > @@ -1333,7 +1333,8 @@ static int parse_and_validate_options(int argc, const char *argv[],
> >  		} else {
> >  			fixup_commit = fixup_message;
> >  			fixup_prefix = "fixup";
> > -			use_editor = 0;
> > +			if (0 > edit_flag)
> 
> Writing this as
> 
> 			if (edit_flag < 0)
> 
> makes it far easier to immediately see that we are talking about a
> nagetive edit_flag.
> 

Agree, I'll change it.
I was unsure of the style and copied from the earlier condition:
	if (0 <= edit_flag)
		use_editor = edit_flag;

> > +				use_editor = 0;
> >  		}
> >  	}
> >  

> 
> Use write_script helper from test-lib-functions.sh here and lose the
> hardcoded reference to /bin/sh.
> 

Ah, missed that one.

Thanks.

/JK
Junio C Hamano Aug. 12, 2021, 7:51 p.m. UTC | #3
"Joel Klinghed" <the_jk@spawned.biz> writes:

>> Writing this as
>> 
>> 			if (edit_flag < 0)
>> 
>> makes it far easier to immediately see that we are talking about a
>> nagetive edit_flag.
>> 
>
> Agree, I'll change it.
> I was unsure of the style and copied from the earlier condition:
> 	if (0 <= edit_flag)
> 		use_editor = edit_flag;

There are two valid schools of thought when it comes to comparison.

Some folks consider that a comparison between a variable and a
constant is a statement about the variable, hence the expression
should be

		if (VARIRABLE comparison-operator CONSTANT)

They will write things like:

		if (edit_flag >= 0)
		if (edit_flag < 0)

Other folks consider that textual order of the comparison should
match the actual order of the things being compared, as if they are
arranged on a number line, hence the expression should be

		if (SMALLER < LARGER)

no matter which one is variable and which one is constant.

They will write:

		if (0 <= edit_flag)
		if (edit_flag < 0)

The case in question, asserting that edit_flag is negative, is what
both camps agree how to write.
diff mbox series

Patch

diff --git a/builtin/commit.c b/builtin/commit.c
index 190d215d43b..4c5286840c5 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1333,7 +1333,8 @@  static int parse_and_validate_options(int argc, const char *argv[],
 		} else {
 			fixup_commit = fixup_message;
 			fixup_prefix = "fixup";
-			use_editor = 0;
+			if (0 > edit_flag)
+				use_editor = 0;
 		}
 	}
 
diff --git a/t/t7500-commit-template-squash-signoff.sh b/t/t7500-commit-template-squash-signoff.sh
index 7d02f79c0de..d71c7812180 100755
--- a/t/t7500-commit-template-squash-signoff.sh
+++ b/t/t7500-commit-template-squash-signoff.sh
@@ -281,6 +281,21 @@  test_expect_success 'commit --fixup -m"something" -m"extra"' '
 
 extra"
 '
+test_expect_success 'commit --fixup --edit' '
+	commit_for_rebase_autosquash_setup &&
+	cat >e-append <<-\EOF &&
+	#!/bin/sh
+	sed -e "2a\\
+something\\
+extra" <"$1" >"$1-"
+	mv "$1-" "$1"
+	EOF
+	chmod 755 e-append &&
+	EDITOR="./e-append" git commit --fixup HEAD~1 --edit &&
+	commit_msg_is "fixup! target message subject linesomething
+extra"
+'
+
 get_commit_msg () {
 	rev="$1" &&
 	git log -1 --pretty=format:"%B" "$rev"