Skip to contentSkip to conversation

rebase -i: introduce the 'break' command

PATCH Superseded Johannes Schindelin via GitGitGadget 7 participants 27 messages Oct 3, 2018 – Oct 26, 2018 Documentation

lore
Share & tools
lore
#0 lore raw

cover rebase -i: introduce the 'break' command

Stefan asked a while back
[https://public-inbox.org/git/[email protected]/]
for a todo command in interactive rebases that would essentially perform the "stop" part of the edit command, but without the "pick" part: interrupt the interactive rebase, with exit code 0, letting the user do things and stuff and look around, with the idea of continuing the rebase later (using git rebase --continue).

This patch introduces that, based on ag/rebase-i-in-c.

Johannes Schindelin (1):
rebase -i: introduce the 'break' command

 rebase-interactive.c       | 1 +
 sequencer.c                | 7 ++++++-
 t/lib-rebase.sh            | 2 +-
 t/t3418-rebase-continue.sh | 9 +++++++++
 4 files changed, 17 insertions(+), 2 deletions(-)

base-commit: b3fe2e1f8cbf5522e7ba49db76bff38f204e2093
Published-As: https://github.com/gitgitgadget/git/releases/tags/pr-43%2Fdscho%2Frebase-i-break-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-43/dscho/rebase-i-break-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/43

Signature · 1 line
gitgitgadget
#1 lore raw

PATCH 1/1 rebase -i: introduce the 'break' command

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---
 rebase-interactive.c       | 1 +
 sequencer.c                | 7 ++++++-
 t/lib-rebase.sh            | 2 +-
 t/t3418-rebase-continue.sh | 9 +++++++++
 4 files changed, 17 insertions(+), 2 deletions(-)
rebase-interactive.c +1 -0
index 0f4119cbae..78f3263fc1 100644
@@ -14,6 +14,7 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 "s, squash <commit> = use commit, but meld into previous commit\n"
 "f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
 "x, exec <command> = run command (the rest of the line) using shell\n"
+"b, break = stop here (continue rebase later with 'git rebase --continue')\n"
 "d, drop <commit> = remove commit\n"
 "l, label <label> = label current HEAD with a name\n"
 "t, reset <label> = reset HEAD to a label\n"
sequencer.c +6 -1
index 8dd6db5a01..b209f8af46 100644
@@ -1416,6 +1416,7 @@ enum todo_command {
 	TODO_SQUASH,
 	/* commands that do something else than handling a single commit */
 	TODO_EXEC,
+	TODO_BREAK,
 	TODO_LABEL,
 	TODO_RESET,
 	TODO_MERGE,
@@ -1437,6 +1438,7 @@ static struct {
 	{ 'f', "fixup" },
 	{ 's', "squash" },
 	{ 'x', "exec" },
+	{ 'b', "break" },
 	{ 'l', "label" },
 	{ 't', "reset" },
 	{ 'm', "merge" },
@@ -1964,7 +1966,7 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 	padding = strspn(bol, " \t");
 	bol += padding;
 
-	if (item->command == TODO_NOOP) {
+	if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
 		if (bol != eol)
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;
 		}
 		if (item->command <= TODO_SQUASH) {
 			if (is_rebase_i(opts))
t/lib-rebase.sh +1 -1
index 25a77ee5cb..584604ee63 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*)
+		exec*|break)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +9 -0
index c145dbac38..185a491089 100755
@@ -239,5 +239,14 @@ test_rerere_autoupdate -m
 GIT_SEQUENCE_EDITOR=: && export GIT_SEQUENCE_EDITOR
 test_rerere_autoupdate -i
 test_rerere_autoupdate --preserve-merges
+unset GIT_SEQUENCE_EDITOR
+
+test_expect_success 'the todo command "break" works' '
+	rm -f execed &&
+	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
+	test_path_is_file execed
+'
 
 test_done
Signature · 1 line
gitgitgadget
#2 lore raw

"Johannes Schindelin via GitGitGadget" <[email protected]>

Quoted 11 lines · writes:

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

Quoted 5 lines

This commit introduces that functionality, as the spanking new 'break' command.

---

If one wants to emulate this with the versions of Git that are currently deployed, would it be sufficient to insert "exec false" instead of "break"?

The reason I am asking is *not* to imply that we do not need this new feature. It is because I vaguely recall seeing a request to add 'pause' to the insn set and "exec false" was mentioned as a more general alternative long time ago. I am trying to see if this is a recurring request/wish, because it would reinforce that this new feature would be a good addition if that is the case.

I suspect that "exec false" would give a message that looks like a complaint ("'false' failed so we are giving you control back to fix things" or something like that), and having a dedicated way to pause the execution without alarming the user is a good idea.

I think the earlier request asked for 'pause' (I didn't dig the list archive very carefully, though), and 'stop' may also be a possible verb, but I tend to agree with this patch that 'break' is probably the best choice, simply because it begins with 'b' in the abbreviated form, a letter that is not yet used by others (unlike 'pause' or 'stop' that would want 'p' and 's' that are already taken)..

Here is a tangent, but I think the description of "-x <cmd>" in "git rebase --continue" should mention that a failing command would interrupt the sequencer. That fact about "exec" command is given much later in the last part of the "interactive mode" section of the manual, so technically our docs are not being incomplete, but the current description is not helpful to those who are looking for substring "exec" from the beginning of the documentation to find out if the exit status of the command affects the way commits are replayed (which is what I was doing when imagining how users would emulate this feature with deployed versions of Git).

Perhaps something as simple as this...

 Documentation/git-rebase.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/git-rebase.txt +2 -1
index 0e20a66e73..0fc5a851b5 100644
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
 	Append "exec <cmd>" after each line creating a commit in the
 	final history. <cmd> will be interpreted as one or more shell
-	commands.
+	commands, and interrupts the rebase session when it exits with
+	non-zero status.
 +
 You may execute several commands by either using one instance of `--exec`
 with several commands:

Also, it seems that this has some interaction with the topics in flight; the added test does pass when queued on top of 'master', but fails when merged to 'pu'. I didn't look into the details as I am not fully online yet.

Thanks.

#3 lore raw
Quoted 16 lines · Junio C Hamano

If one wants to emulate this with the versions of Git that are currently deployed, would it be sufficient to insert "exec false" instead of "break"?

The reason I am asking is *not* to imply that we do not need this new feature. It is because I vaguely recall seeing a request to add 'pause' to the insn set and "exec false" was mentioned as a more general alternative long time ago. I am trying to see if this is a recurring request/wish, because it would reinforce that this new feature would be a good addition if that is the case.

I suspect that "exec false" would give a message that looks like a complaint ("'false' failed so we are giving you control back to fix things" or something like that), and having a dedicated way to pause the execution without alarming the user is a good idea.

Quoted 8 lines

I think the earlier request asked for 'pause' (I didn't dig the list archive very carefully, though), and 'stop' may also be a possible verb, but I tend to agree with this patch that 'break' is probably the best choice, simply because it begins with 'b' in the abbreviated form, a letter that is not yet used by others (unlike 'pause' or 'stop' that would want 'p' and 's' that are already taken)..

Yea. I use "exec false" all the time for this purpose, but it's a bit confusing, and it does cause rebase to indicate that a command failed.

I think adding a builtin command to do this is a good idea, and I think break is a reasonable verb, (especially considering the shorthand "b").

Regards,
Jake

#4 lore raw
In reply to Junio C Hamano

Hi Junio,

Quoted 16 lines · Junio C Hamano

"Johannes Schindelin via GitGitGadget" <[email protected]>

Quoted 13 lines · writes:

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

Quoted 7 lines
Quoted 3 lines

---

If one wants to emulate this with the versions of Git that are currently deployed, would it be sufficient to insert "exec false" instead of "break"?

There is one crucial difference: the exit code.

If you are scripting around git rebase -i (and I do, heavily), then that is quite a difference: who's to say that the rebase "failed" because of that exec false, or if it failed another exec unexpectedly?

Quoted 7 lines

The reason I am asking is *not* to imply that we do not need this new feature. It is because I vaguely recall seeing a request to add 'pause' to the insn set and "exec false" was mentioned as a more general alternative long time ago. I am trying to see if this is a recurring request/wish, because it would reinforce that this new feature would be a good addition if that is the case.

Quoted 7 lines

I suspect that "exec false" would give a message that looks like a complaint ("'false' failed so we are giving you control back to fix things" or something like that), and having a dedicated way to pause the execution without alarming the user is a good idea.

I think the earlier request asked for 'pause' (I didn't dig the list archive very carefully, though),

No need to: I mentioned it in the cover letter. Here is the link again, for your convenience:
https://public-inbox.org/git/[email protected]/

Quoted 27 lines

and 'stop' may also be a possible verb, but I tend to agree with this patch that 'break' is probably the best choice, simply because it begins with 'b' in the abbreviated form, a letter that is not yet used by others (unlike 'pause' or 'stop' that would want 'p' and 's' that are already taken)..

Here is a tangent, but I think the description of "-x <cmd>" in "git rebase --continue" should mention that a failing command would interrupt the sequencer. That fact about "exec" command is given much later in the last part of the "interactive mode" section of the manual, so technically our docs are not being incomplete, but the current description is not helpful to those who are looking for substring "exec" from the beginning of the documentation to find out if the exit status of the command affects the way commits are replayed (which is what I was doing when imagining how users would emulate this feature with deployed versions of Git).

Perhaps something as simple as this...

 Documentation/git-rebase.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/git-rebase.txt +0 -0
index 0e20a66e73..0fc5a851b5 100644

Documentation/git-rebase.txt idea unless you know what you are doing (see BUGS below). · line 424

Quoted 6 lines
Documentation/git-rebase.txt +2 -1
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
 	Append "exec <cmd>" after each line creating a commit in the
 	final history. <cmd> will be interpreted as one or more shell
-	commands.
+	commands, and interrupts the rebase session when it exits with
+	non-zero status.

Good initial version. I would like it to be a bit more precise about who exits with what status. How about this:

+ commands. Any command that fails will interrupt the rebase,
+ with exit code 1.

Quoted 9 lines
Documentation/git-rebase.txt +0 -0
 +
 You may execute several commands by either using one instance of `--exec`
 with several commands:

Also, it seems that this has some interaction with the topics in flight; the added test does pass when queued on top of 'master', but fails when merged to 'pu'. I didn't look into the details as I am not fully online yet.

I had a similar issue in a preliminary revision, and had to unset GIT_EDITOR to fix it. Probably the culprit here is the same; I could imagine that core.editor was set by another topic.

[... clicketiclick, debug debug debug, 1.5h later...]

Actually, this is not the problem. The problem is that the interactive rebase exits with status 0 but does not leave a stopped-sha file behind, and the builtin rebase mistakes that for a sign that it can clean up the state dir.

However, we definitely do not want to leave that file, because it indicates a fixup or squash with merge conflicts was left behind.

Taking a step back, it appears that we do a whole lot of work for nothing in the case of the interactive rebase: it cleans up the state directory itself already, and takes care of the autostash support, too.

So I will apply this fixup js/rebase-in-c-5.5-work-with-rebase-i-in-c:

-- snip --
fixup! builtin rebase: prepare for builtin rebase -i

The original patch worked, but overlooked the fact that git rebase--interactive really wants to take care of finishing the rebase itself.

While it was not harmful to try again, there was no directory to work with, so no harm was done. Except in the case that an edit command was processed, in which case we used the stopped-sha file as tell-tale that we should not remove the state directory.

However, with the break command we do not have such a tell-tale. But then, we don't really need one: the built-in rebase--interactive takes care of clean-up itself. So we can just skip it in the built-in rebase.

While at it, remove the case arm for the interactive rebase that is now skipped in favor of the short-cut to the built-in rebase.

---
 builtin/rebase.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
builtin/rebase.c +3 -4
index 99fd5d4017..2ca5fa1d74 100644
@@ -410,6 +410,7 @@ static int run_specific_rebase(struct rebase_options *opts)
 			argv_array_push(&child.args, "--signoff");
 
 		status = run_command(&child);
+
 		goto finished_rebase;
 	}
 
@@ -475,10 +476,6 @@ static int run_specific_rebase(struct rebase_options *opts)
 		backend = "git-rebase--am";
 		backend_func = "git_rebase__am";
 		break;
-	case REBASE_INTERACTIVE:
-		backend = "git-rebase--interactive";
-		backend_func = "git_rebase__interactive";
-		break;
 	case REBASE_MERGE:
 		backend = "git-rebase--merge";
 		backend_func = "git_rebase__merge";
@@ -501,6 +498,8 @@ static int run_specific_rebase(struct rebase_options *opts)
 finished_rebase:
 	if (opts->dont_finish_rebase)
 		; /* do nothing */
+	else if (opts->type == REBASE_INTERACTIVE)
+		; /* interactive rebase cleans up after itself */
 	else if (status == 0) {
 		if (!file_exists(state_dir_path("stopped-sha", opts)))
 			finish_rebase(opts);

-- snap --

This fix-up seems to unbreak the break test case (pun intended)...

Ciao,
Dscho

Signature · 1 line
2.19.0.windows.1.30.g502e856705
Quoted 3 lines

Thanks.

#5 lore raw
Quoted 12 lines · Johannes Schindelin

Hi Junio,

Quoted 8 lines · Junio C Hamano

"Johannes Schindelin via GitGitGadget" <[email protected]>

Quoted 5 lines · writes:

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Quoted 6 lines
Quoted 4 lines

...
If one wants to emulate this with the versions of Git that are currently deployed, would it be sufficient to insert "exec false" instead of "break"?

There is one crucial difference: the exit code.

OK, and it was good that you explicitly said "with exit code 0" in the log message. Together with the idea to update the doc I floated earlier, this probably is worth documenting, too.

Quoted 6 lines
Quoted 2 lines

I think the earlier request asked for 'pause' (I didn't dig the list archive very carefully, though),

No need to: I mentioned it in the cover letter. Here is the link again, for your convenience:
https://public-inbox.org/git/[email protected]/

No, you misunderstood. I knew what message in the immediate past triggered this patch and that wasn't what I "could have dug for but didn't". "The earlier request" I meant was another one I recall that was made long time ago---that was what I "could have dug for but didn't".

Quoted 2 lines

Good initial version. I would like it to be a bit more precise about who exits with what status. How about this:

Sounds good. It is likely that I'll either forget or will continue to be too busy to pick textual pieces and assemble together myself, so I'll leave it as a left over bit for somebody reading from the sideline to send in a finished version if they care deeply enough ;-)

Thanks.

#6 lore raw
Quoted 5 lines · Junio C Hamano
Quoted 1 line

There is one crucial difference: the exit code.

OK, and it was good that you explicitly said "with exit code 0" in the log message. Together with the idea to update the doc I floated earlier, this probably is worth documenting, too.

Heh, I am becoming sloppy in reviewing. The patch does not even update any doc.

It is not a reason to reject the change (the change looks reasonably simple and reviewers and those who have to look at the code to build upon it would understand it in the current shape), but it is a blocker for the change to be merged to 'next' and down.

#7 lore raw

v2 cover rebase -i: introduce the 'break' command

In reply to Johannes Schindelin via GitGitGadget

Stefan asked a while back
[https://public-inbox.org/git/[email protected]/]
for a todo command in interactive rebases that would essentially perform the "stop" part of the edit command, but without the "pick" part: interrupt the interactive rebase, with exit code 0, letting the user do things and stuff and look around, with the idea of continuing the rebase later (using git rebase --continue).

This patch introduces that, based on ag/rebase-i-in-c.

Changes since v1:

* Wrapped the commit message correctly.
* Added a preparatory patch to mention what happens in case an exec fails.
* Mentioned the break command in the git-rebase(1) documentation.

Johannes Schindelin (2):
rebase -i: clarify what happens on a failed exec rebase -i: introduce the 'break' command

 Documentation/git-rebase.txt | 6 +++++-
 rebase-interactive.c         | 1 +
 sequencer.c                  | 7 ++++++-
 t/lib-rebase.sh              | 2 +-
 t/t3418-rebase-continue.sh   | 9 +++++++++
 5 files changed, 22 insertions(+), 3 deletions(-)

base-commit: 34b47315d9721a576b9536492cca0c11588113a2
Published-As: https://github.com/gitgitgadget/git/releases/tags/pr-43%2Fdscho%2Frebase-i-break-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-43/dscho/rebase-i-break-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/43

Range-diff vs v1:

 -:  ---------- > 1:  2eefdb4874 rebase -i: clarify what happens on a failed `exec`
 1:  b358178548 ! 2:  c74e02c4b6 rebase -i: introduce the 'break' command

@@ -11,11 +11,26 @@
before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

- This commit introduces that functionality, as the spanking new 'break' command.
+ This commit introduces that functionality, as the spanking new 'break'
+ command.

+diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt +--- a/Documentation/git-rebase.txt
++++ b/Documentation/git-rebase.txt
+@@
+ the files and/or the commit message, amend the commit, and continue
+ rebasing.
+
++To interrupt the rebase (just like an "edit" command would do, but without ++cherry-picking any commit first), use the "break" command.
++
+ If you just want to edit the commit message for a commit, replace the
+ command "pick" with the command "reword".
+
+
diff --git a/rebase-interactive.c b/rebase-interactive.c
--- a/rebase-interactive.c
+++ b/rebase-interactive.c

Signature · 1 line
gitgitgadget
#8 lore raw

PATCH v2 1/2 rebase -i: clarify what happens on a failed `exec`

From: Johannes Schindelin <[email protected]>

We had not documented previously what happens when an exec command in an interactive rebase fails. Now we do.

---
 Documentation/git-rebase.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/git-rebase.txt +2 -1
index 091eb53faa..db2faca73c 100644
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
 	Append "exec <cmd>" after each line creating a commit in the
 	final history. <cmd> will be interpreted as one or more shell
-	commands.
+	commands. Anz command that fails will interrupt the rebase,
+	withe exit code 1.
 +
 You may execute several commands by either using one instance of `--exec`
 with several commands:
Signature · 1 line
gitgitgadget
#9 lore raw

Re: [PATCH v2 1/2] rebase -i: clarify what happens on a failed `exec`

Documentation/git-rebase.txt idea unless you know what you are doing (see BUGS below). · line 424

Quoted 13 lines · Johannes Schindelin via GitGitGadget

We had not documented previously what happens when an exec command in an interactive rebase fails. Now we do.

---

Documentation/git-rebase.txt +2 -1
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
        Append "exec <cmd>" after each line creating a commit in the
        final history. <cmd> will be interpreted as one or more shell
-       commands.
+       commands. Anz command that fails will interrupt the rebase,
+       withe exit code 1.

s/Anz/Any/
s/withe/with/

#10 lore raw

Re: [PATCH v2 1/2] rebase -i: clarify what happens on a failed `exec`

Quoted 5 lines · Eric Sunshine
Quoted 3 lines · Johannes Schindelin via GitGitGadget

We had not documented previously what happens when an exec command in an interactive rebase fails. Now we do.

Quoted 13 lines

Documentation/git-rebase.txt idea unless you know what you are doing (see BUGS below). · line 424

Quoted 10 lines

---

Documentation/git-rebase.txt +2 -1
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
        Append "exec <cmd>" after each line creating a commit in the
        final history. <cmd> will be interpreted as one or more shell
-       commands.
+       commands. Anz command that fails will interrupt the rebase,
+       withe exit code 1.

s/Anz/Any/
s/withe/with/

Heh, I know I am not good at spelling, either, but hopefully I am a bit more careful than leaving as many typoes as I have added lines in my patch X-<. After all, it's not a race to send in patches as quickly as possible.

Queued. Thanks, both.

#11 lore raw

Re: [PATCH v2 1/2] rebase -i: clarify what happens on a failed `exec`

Hi Junio & Eric,

Quoted 7 lines · Junio C Hamano
Quoted 5 lines · Eric Sunshine
Quoted 3 lines · Johannes Schindelin via GitGitGadget

We had not documented previously what happens when an exec command in an interactive rebase fails. Now we do.

Quoted 13 lines
Quoted 5 lines
Quoted 5 lines

---

Documentation/git-rebase.txt +0 -0
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
Quoted 8 lines

Documentation/git-rebase.txt idea unless you know what you are doing (see BUGS below). · line 424

Quoted 5 lines
Documentation/git-rebase.txt +2 -1
        Append "exec <cmd>" after each line creating a commit in the
        final history. <cmd> will be interpreted as one or more shell
-       commands.
+       commands. Anz command that fails will interrupt the rebase,
+       withe exit code 1.

s/Anz/Any/
s/withe/with/

These tyopes will be fxied in the nxet itaretion.

Ciao,
Dhsco

Quoted 8 lines

Heh, I know I am not good at spelling, either, but hopefully I am a bit more careful than leaving as many typoes as I have added lines in my patch X-<. After all, it's not a race to send in patches as quickly as possible.

Queued. Thanks, both.

#12 lore raw

PATCH v2 2/2 rebase -i: introduce the 'break' command

In reply to Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---
 Documentation/git-rebase.txt | 3 +++
 rebase-interactive.c         | 1 +
 sequencer.c                  | 7 ++++++-
 t/lib-rebase.sh              | 2 +-
 t/t3418-rebase-continue.sh   | 9 +++++++++
 5 files changed, 20 insertions(+), 2 deletions(-)
Documentation/git-rebase.txt +3 -0
index db2faca73c..5bed1da36b 100644
@@ -561,6 +561,9 @@ By replacing the command "pick" with the command "edit", you can tell
 the files and/or the commit message, amend the commit, and continue
 rebasing.
 
+To interrupt the rebase (just like an "edit" command would do, but without
+cherry-picking any commit first), use the "break" command.
+
 If you just want to edit the commit message for a commit, replace the
 command "pick" with the command "reword".
 
rebase-interactive.c +1 -0
index 0f4119cbae..78f3263fc1 100644
@@ -14,6 +14,7 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 "s, squash <commit> = use commit, but meld into previous commit\n"
 "f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
 "x, exec <command> = run command (the rest of the line) using shell\n"
+"b, break = stop here (continue rebase later with 'git rebase --continue')\n"
 "d, drop <commit> = remove commit\n"
 "l, label <label> = label current HEAD with a name\n"
 "t, reset <label> = reset HEAD to a label\n"
sequencer.c +6 -1
index 8dd6db5a01..b209f8af46 100644
@@ -1416,6 +1416,7 @@ enum todo_command {
 	TODO_SQUASH,
 	/* commands that do something else than handling a single commit */
 	TODO_EXEC,
+	TODO_BREAK,
 	TODO_LABEL,
 	TODO_RESET,
 	TODO_MERGE,
@@ -1437,6 +1438,7 @@ static struct {
 	{ 'f', "fixup" },
 	{ 's', "squash" },
 	{ 'x', "exec" },
+	{ 'b', "break" },
 	{ 'l', "label" },
 	{ 't', "reset" },
 	{ 'm', "merge" },
@@ -1964,7 +1966,7 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 	padding = strspn(bol, " \t");
 	bol += padding;
 
-	if (item->command == TODO_NOOP) {
+	if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
 		if (bol != eol)
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;
 		}
 		if (item->command <= TODO_SQUASH) {
 			if (is_rebase_i(opts))
t/lib-rebase.sh +1 -1
index 25a77ee5cb..584604ee63 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*)
+		exec*|break)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +9 -0
index c145dbac38..185a491089 100755
@@ -239,5 +239,14 @@ test_rerere_autoupdate -m
 GIT_SEQUENCE_EDITOR=: && export GIT_SEQUENCE_EDITOR
 test_rerere_autoupdate -i
 test_rerere_autoupdate --preserve-merges
+unset GIT_SEQUENCE_EDITOR
+
+test_expect_success 'the todo command "break" works' '
+	rm -f execed &&
+	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
+	test_path_is_file execed
+'
 
 test_done
Signature · 1 line
gitgitgadget
#13 lore raw

Hi Johannes

I think this would be a useful addition to rebase, there's one small comment below.

Quoted 80 lines · Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---
 Documentation/git-rebase.txt | 3 +++
 rebase-interactive.c         | 1 +
 sequencer.c                  | 7 ++++++-
 t/lib-rebase.sh              | 2 +-
 t/t3418-rebase-continue.sh   | 9 +++++++++
 5 files changed, 20 insertions(+), 2 deletions(-)
Documentation/git-rebase.txt +3 -0
index db2faca73c..5bed1da36b 100644
@@ -561,6 +561,9 @@ By replacing the command "pick" with the command "edit", you can tell
 the files and/or the commit message, amend the commit, and continue
 rebasing.
 
+To interrupt the rebase (just like an "edit" command would do, but without
+cherry-picking any commit first), use the "break" command.
+
 If you just want to edit the commit message for a commit, replace the
 command "pick" with the command "reword".
 
rebase-interactive.c +1 -0
index 0f4119cbae..78f3263fc1 100644
@@ -14,6 +14,7 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 "s, squash <commit> = use commit, but meld into previous commit\n"
 "f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
 "x, exec <command> = run command (the rest of the line) using shell\n"
+"b, break = stop here (continue rebase later with 'git rebase --continue')\n"
 "d, drop <commit> = remove commit\n"
 "l, label <label> = label current HEAD with a name\n"
 "t, reset <label> = reset HEAD to a label\n"
sequencer.c +3 -1
index 8dd6db5a01..b209f8af46 100644
@@ -1416,6 +1416,7 @@ enum todo_command {
 	TODO_SQUASH,
 	/* commands that do something else than handling a single commit */
 	TODO_EXEC,
+	TODO_BREAK,
 	TODO_LABEL,
 	TODO_RESET,
 	TODO_MERGE,
@@ -1437,6 +1438,7 @@ static struct {
 	{ 'f', "fixup" },
 	{ 's', "squash" },
 	{ 'x', "exec" },
+	{ 'b', "break" },
 	{ 'l', "label" },
 	{ 't', "reset" },
 	{ 'm', "merge" },
@@ -1964,7 +1966,7 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 	padding = strspn(bol, " \t");
 	bol += padding;
 
-	if (item->command == TODO_NOOP) {
+	if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
 		if (bol != eol)
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3300

Quoted 6 lines
sequencer.c +3 -0
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;

Normally when rebase stops it prints a message to say where it has got to and how to continue, it might be useful to do the same here

Best Wishes

Phillip

Quoted 36 lines
sequencer.c +0 -0
 		}
 		if (item->command <= TODO_SQUASH) {
 			if (is_rebase_i(opts))
t/lib-rebase.sh +1 -1
index 25a77ee5cb..584604ee63 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*)
+		exec*|break)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +9 -0
index c145dbac38..185a491089 100755
@@ -239,5 +239,14 @@ test_rerere_autoupdate -m
 GIT_SEQUENCE_EDITOR=: && export GIT_SEQUENCE_EDITOR
 test_rerere_autoupdate -i
 test_rerere_autoupdate --preserve-merges
+unset GIT_SEQUENCE_EDITOR
+
+test_expect_success 'the todo command "break" works' '
+	rm -f execed &&
+	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
+	test_path_is_file execed
+'
 
 test_done
#14 lore raw

Hi Phillip,

Quoted 78 lines · Phillip Wood

I think this would be a useful addition to rebase, there's one small comment below.

Quoted 74 lines · Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---
 Documentation/git-rebase.txt | 3 +++
 rebase-interactive.c         | 1 +
 sequencer.c                  | 7 ++++++-
 t/lib-rebase.sh              | 2 +-
 t/t3418-rebase-continue.sh   | 9 +++++++++
 5 files changed, 20 insertions(+), 2 deletions(-)
Documentation/git-rebase.txt +3 -0
index db2faca73c..5bed1da36b 100644
@@ -561,6 +561,9 @@ By replacing the command "pick" with the command "edit", you can tell
 the files and/or the commit message, amend the commit, and continue
 rebasing.
 
+To interrupt the rebase (just like an "edit" command would do, but without
+cherry-picking any commit first), use the "break" command.
+
 If you just want to edit the commit message for a commit, replace the
 command "pick" with the command "reword".
 
rebase-interactive.c +1 -0
index 0f4119cbae..78f3263fc1 100644
@@ -14,6 +14,7 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 "s, squash <commit> = use commit, but meld into previous commit\n"
 "f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
 "x, exec <command> = run command (the rest of the line) using shell\n"
+"b, break = stop here (continue rebase later with 'git rebase --continue')\n"
 "d, drop <commit> = remove commit\n"
 "l, label <label> = label current HEAD with a name\n"
 "t, reset <label> = reset HEAD to a label\n"
sequencer.c +2 -0
index 8dd6db5a01..b209f8af46 100644
@@ -1416,6 +1416,7 @@ enum todo_command {
 	TODO_SQUASH,
 	/* commands that do something else than handling a single commit */
 	TODO_EXEC,
+	TODO_BREAK,
 	TODO_LABEL,
 	TODO_RESET,
 	TODO_MERGE,
@@ -1437,6 +1438,7 @@ static struct {
 	{ 'f', "fixup" },
 	{ 's', "squash" },
 	{ 'x', "exec" },
+	{ 'b', "break" },
 	{ 'l', "label" },
 	{ 't', "reset" },
 	{ 'm', "merge" },
@@ -1964,7 +1966,7 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 	padding = strspn(bol, " \t");
 	bol += padding;
 
Quoted 15 lines

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3300

Quoted 12 lines
sequencer.c +4 -1
-	if (item->command == TODO_NOOP) {
+	if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
 		if (bol != eol)
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;

Normally when rebase stops it prints a message to say where it has got to and how to continue, it might be useful to do the same here

That's a very valid point. I'll think of something.

Ciao,
Dscho

Quoted 43 lines

Best Wishes

Phillip

Quoted 36 lines
sequencer.c +0 -0
 		}
 		if (item->command <= TODO_SQUASH) {
 			if (is_rebase_i(opts))
t/lib-rebase.sh +1 -1
index 25a77ee5cb..584604ee63 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*)
+		exec*|break)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +9 -0
index c145dbac38..185a491089 100755
@@ -239,5 +239,14 @@ test_rerere_autoupdate -m
 GIT_SEQUENCE_EDITOR=: && export GIT_SEQUENCE_EDITOR
 test_rerere_autoupdate -i
 test_rerere_autoupdate --preserve-merges
+unset GIT_SEQUENCE_EDITOR
+
+test_expect_success 'the todo command "break" works' '
+	rm -f execed &&
+	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
+	test_path_is_file execed
+'
 
 test_done
#15 lore raw

Hi Johannes

Quoted 42 lines · Johannes Schindelin

Hi Phillip,

Quoted 27 lines · Phillip Wood

I think this would be a useful addition to rebase, there's one small comment below.

Quoted 22 lines · Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---

sequencer.c +0 -0
index 8dd6db5a01..b209f8af46 100644
Quoted 10 lines

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3300

Quoted 7 lines
sequencer.c +3 -0
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;

Normally when rebase stops it prints a message to say where it has got to and how to continue, it might be useful to do the same here

Quoted 1 line

That's a very valid point. I'll think of something.

I'm not sure what gets left on the screen from the previous picks but something to say what the last pick/exec was and maybe what the current HEAD is would be useful I think. One thing has just occurred to me - what does git status say (and does it still work - I'm not sure how much parsing it does on the todo and done files) if it is run while rebase is stopped on a break command?

Best Wishes

Phillip

#16 lore raw

Hi Phillip,

Quoted 44 lines · Phillip Wood

Hi Johannes

Quoted 42 lines · Johannes Schindelin

Hi Phillip,

Quoted 37 lines · Phillip Wood

I think this would be a useful addition to rebase, there's one small comment below.

Quoted 24 lines · Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---

sequencer.c +0 -0
index 8dd6db5a01..b209f8af46 100644

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3300

Quoted 6 lines
sequencer.c +3 -0
@@ -3293,6 +3295,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				break;

Normally when rebase stops it prints a message to say where it has got to and how to continue, it might be useful to do the same here

Quoted 5 lines
Quoted 1 line

That's a very valid point. I'll think of something.

I'm not sure what gets left on the screen from the previous picks but something to say what the last pick/exec was and maybe what the current HEAD is would be useful I think.

I first wanted to do that, imitating the "Stopped at <hex>... <oneline>" of an edit command, but it *is* now possible that we are on an unborn branch... which will look a bit funny, I guess, as we construct a very special place-holder commit to be HEAD in that case.

Quoted 3 lines

One thing has just occurred to me - what does git status say (and does it still work - I'm not sure how much parsing it does on the todo and done files) if it is run while rebase is stopped on a break command?

I don't think it says anything special, really. It just reports that we're in the middle of a rebase, listing up to two already-processed and up to two to-be-processed todo commands.

Ciao,
Dscho

#17 lore raw

v3 cover rebase -i: introduce the 'break' command

In reply to Johannes Schindelin via GitGitGadget

Stefan asked a while back
[https://public-inbox.org/git/[email protected]/]
for a todo command in interactive rebases that would essentially perform the "stop" part of the edit command, but without the "pick" part: interrupt the interactive rebase, with exit code 0, letting the user do things and stuff and look around, with the idea of continuing the rebase later (using git rebase --continue).

This patch introduces that, based on ag/rebase-i-in-c.

Changes since v2:

* Fixed two typos.
* When interrupting the rebase, break now outputs a message.

Changes since v1:

* Wrapped the commit message correctly.
* Added a preparatory patch to mention what happens in case an exec fails.
* Mentioned the break command in the git-rebase(1) documentation.

Cc: Stefan Beller [email protected] [[email protected]]Cc: Eric Sunshine [email protected] [[email protected]]

Johannes Schindelin (2):
rebase -i: clarify what happens on a failed exec rebase -i: introduce the 'break' command

 Documentation/git-rebase.txt |  6 +++++-
 rebase-interactive.c         |  1 +
 sequencer.c                  | 24 +++++++++++++++++++++++-
 t/lib-rebase.sh              |  2 +-
 t/t3418-rebase-continue.sh   |  9 +++++++++
 5 files changed, 39 insertions(+), 3 deletions(-)

base-commit: 34b47315d9721a576b9536492cca0c11588113a2
Published-As: https://github.com/gitgitgadget/git/releases/tags/pr-43%2Fdscho%2Frebase-i-break-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-43/dscho/rebase-i-break-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/43

Range-diff vs v2:

1: 2eefdb4874 ! 1: 92512a82d2 rebase -i: clarify what happens on a failed exec
@@ -15,8 +15,8 @@
Append "exec <cmd>" after each line creating a commit in the final history. <cmd> will be interpreted as one or more shell
- commands.
-+ commands. Anz command that fails will interrupt the rebase,
-+ withe exit code 1.
++ commands. Any command that fails will interrupt the rebase,
++ with exit code 1.
+
You may execute several commands by either using one instance of --exec with several commands:
2: c74e02c4b6 ! 2: d44b425709 rebase -i: introduce the 'break' command

     @@ -71,13 +71,37 @@
       		if (bol != eol)
       			return error(_("%s does not accept arguments: '%s'"),
       				     command_to_string(item->command), bol);
     +@@
     + 	return update_ref(NULL, "ORIG_HEAD", &oid, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
     + }
     + 
     ++static int stopped_at_head(void)
     ++{
     ++	struct object_id head;
     ++	struct commit *commit;
     ++	struct commit_message message;
     ++
     ++	if (get_oid("HEAD", &head) || !(commit = lookup_commit(&head)) ||
     ++	    parse_commit(commit) || get_message(commit, &message))
     ++		fprintf(stderr, _("Stopped at HEAD\n"));
     ++	else {
     ++		fprintf(stderr, _("Stopped at %s\n"), message.label);
     ++		free_message(commit, &message);
     ++	}
     ++	return 0;
     ++
     ++}
     ++
     + static const char rescheduled_advice[] =
     + N_("Could not execute the todo command\n"
     + "\n"
      @@
       			unlink(rebase_path_stopped_sha());
       			unlink(rebase_path_amend());
       			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
      +
      +			if (item->command == TODO_BREAK)
     -+				break;
     ++				return stopped_at_head();
       		}
       		if (item->command <= TODO_SQUASH) {
       			if (is_rebase_i(opts))
Signature · 1 line
gitgitgadget
#18 lore raw

PATCH v3 1/2 rebase -i: clarify what happens on a failed `exec`

From: Johannes Schindelin <[email protected]>

We had not documented previously what happens when an exec command in an interactive rebase fails. Now we do.

---
 Documentation/git-rebase.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/git-rebase.txt +2 -1
index 091eb53faa..d9771bd25b 100644
@@ -420,7 +420,8 @@ idea unless you know what you are doing (see BUGS below).
 --exec <cmd>::
 	Append "exec <cmd>" after each line creating a commit in the
 	final history. <cmd> will be interpreted as one or more shell
-	commands.
+	commands. Any command that fails will interrupt the rebase,
+	with exit code 1.
 +
 You may execute several commands by either using one instance of `--exec`
 with several commands:
Signature · 1 line
gitgitgadget
#19 lore raw

PATCH v3 2/2 rebase -i: introduce the 'break' command

In reply to Johannes Schindelin via GitGitGadget

From: Johannes Schindelin <[email protected]>

The 'edit' command can be used to cherry-pick a commit and then immediately drop out of the interactive rebase, with exit code 0, to let the user amend the commit, or test it, or look around.

Sometimes this functionality would come in handy *without* cherry-picking a commit, e.g. to interrupt the interactive rebase even before cherry-picking a commit, or immediately after an 'exec' or a 'merge'.

This commit introduces that functionality, as the spanking new 'break' command.

---
 Documentation/git-rebase.txt |  3 +++
 rebase-interactive.c         |  1 +
 sequencer.c                  | 24 +++++++++++++++++++++++-
 t/lib-rebase.sh              |  2 +-
 t/t3418-rebase-continue.sh   |  9 +++++++++
 5 files changed, 37 insertions(+), 2 deletions(-)
Documentation/git-rebase.txt +3 -0
index d9771bd25b..6b71694b0d 100644
@@ -561,6 +561,9 @@ By replacing the command "pick" with the command "edit", you can tell
 the files and/or the commit message, amend the commit, and continue
 rebasing.
 
+To interrupt the rebase (just like an "edit" command would do, but without
+cherry-picking any commit first), use the "break" command.
+
 If you just want to edit the commit message for a commit, replace the
 command "pick" with the command "reword".
 
rebase-interactive.c +1 -0
index 0f4119cbae..78f3263fc1 100644
@@ -14,6 +14,7 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 "s, squash <commit> = use commit, but meld into previous commit\n"
 "f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
 "x, exec <command> = run command (the rest of the line) using shell\n"
+"b, break = stop here (continue rebase later with 'git rebase --continue')\n"
 "d, drop <commit> = remove commit\n"
 "l, label <label> = label current HEAD with a name\n"
 "t, reset <label> = reset HEAD to a label\n"
sequencer.c +23 -1
index 8dd6db5a01..ee3961ec63 100644
@@ -1416,6 +1416,7 @@ enum todo_command {
 	TODO_SQUASH,
 	/* commands that do something else than handling a single commit */
 	TODO_EXEC,
+	TODO_BREAK,
 	TODO_LABEL,
 	TODO_RESET,
 	TODO_MERGE,
@@ -1437,6 +1438,7 @@ static struct {
 	{ 'f', "fixup" },
 	{ 's', "squash" },
 	{ 'x', "exec" },
+	{ 'b', "break" },
 	{ 'l', "label" },
 	{ 't', "reset" },
 	{ 'm', "merge" },
@@ -1964,7 +1966,7 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 	padding = strspn(bol, " \t");
 	bol += padding;
 
-	if (item->command == TODO_NOOP) {
+	if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
 		if (bol != eol)
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
@@ -3247,6 +3249,23 @@ static int checkout_onto(struct replay_opts *opts,
 	return update_ref(NULL, "ORIG_HEAD", &oid, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
 }
 
+static int stopped_at_head(void)
+{
+	struct object_id head;
+	struct commit *commit;
+	struct commit_message message;
+
+	if (get_oid("HEAD", &head) || !(commit = lookup_commit(&head)) ||
+	    parse_commit(commit) || get_message(commit, &message))
+		fprintf(stderr, _("Stopped at HEAD\n"));
+	else {
+		fprintf(stderr, _("Stopped at %s\n"), message.label);
+		free_message(commit, &message);
+	}
+	return 0;
+
+}
+
 static const char rescheduled_advice[] =
 N_("Could not execute the todo command\n"
 "\n"
@@ -3293,6 +3312,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				return stopped_at_head();
 		}
 		if (item->command <= TODO_SQUASH) {
 			if (is_rebase_i(opts))
t/lib-rebase.sh +1 -1
index 25a77ee5cb..584604ee63 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*)
+		exec*|break)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +9 -0
index c145dbac38..185a491089 100755
@@ -239,5 +239,14 @@ test_rerere_autoupdate -m
 GIT_SEQUENCE_EDITOR=: && export GIT_SEQUENCE_EDITOR
 test_rerere_autoupdate -i
 test_rerere_autoupdate --preserve-merges
+unset GIT_SEQUENCE_EDITOR
+
+test_expect_success 'the todo command "break" works' '
+	rm -f execed &&
+	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
+	test_path_is_file execed
+'
 
 test_done
Signature · 1 line
gitgitgadget
#20 lore raw

"Johannes Schindelin via GitGitGadget" <[email protected]>

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3318

Quoted 8 lines · writes:
sequencer.c +3 -0
@@ -3293,6 +3312,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				return stopped_at_head();
 		}

The earlier one had "break;" here, which broke out of the while() loop, let the control reach "if (is_reabse_i(opts)) {" block after the loop, and the block would have noticed that current < nr and returned 0. So from the point of view of the overall control flow of the caller of this function, there is no change relative to v2. The only difference in v3 is that stopped_at_head() gives a useful message.

Good.

#21 lore raw

Hi Junio,

Quoted 19 lines · Junio C Hamano

"Johannes Schindelin via GitGitGadget" <[email protected]>

sequencer.c static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts) · line 3318

Quoted 8 lines · writes:
sequencer.c +3 -0
@@ -3293,6 +3312,9 @@ static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
 			unlink(rebase_path_stopped_sha());
 			unlink(rebase_path_amend());
 			delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
+
+			if (item->command == TODO_BREAK)
+				return stopped_at_head();
 		}

The earlier one had "break;" here, which broke out of the while() loop, let the control reach "if (is_reabse_i(opts)) {" block after the loop, and the block would have noticed that current < nr and returned 0. So from the point of view of the overall control flow of the caller of this function, there is no change relative to v2. The only difference in v3 is that stopped_at_head() gives a useful message.

Well, I should have called out this break; -> return 0; change, too, as I think it makes the code flow *a lot* more obvious. As you say, I relied earlier on the next loop to return early, but that is not what the edit command does: it returns out of the first loop, too.

Quoted 2 lines

Good.

Thanks,
Dscho

Quoted 2 lines
#22 lore raw
In reply to Johannes Schindelin via GitGitGadget

"Johannes Schindelin via GitGitGadget" <[email protected]>

Quoted 6 lines · writes:

This patch introduces that, based on ag/rebase-i-in-c.

Changes since v2:

* Fixed two typos.
* When interrupting the rebase, break now outputs a message.

I was about to merge the whole collection of topics to 'next', but this came to stop me just in time.

The typofixes are appreciated of course, and look trivially correct.

I find that the if() condition that does too many side-effect-full operations in stopped-at-head shows bad taste. It is still short enough to understand what each step is trying to do, but would encourage others who later may touch the code to make it even more complex.

But it is a short and isolated static helper function, so I won't complain too loudly.

Will replace and requeue.

Thanks.

#23 lore raw

Hi Junio,

Quoted 21 lines · Junio C Hamano

"Johannes Schindelin via GitGitGadget" <[email protected]>

Quoted 6 lines · writes:

This patch introduces that, based on ag/rebase-i-in-c.

Changes since v2:

* Fixed two typos.
* When interrupting the rebase, break now outputs a message.

I was about to merge the whole collection of topics to 'next', but this came to stop me just in time.

The typofixes are appreciated of course, and look trivially correct.

I find that the if() condition that does too many side-effect-full operations in stopped-at-head shows bad taste. It is still short enough to understand what each step is trying to do, but would encourage others who later may touch the code to make it even more complex.

Quoted 4 lines

But it is a short and isolated static helper function, so I won't complain too loudly.

Will replace and requeue.

Thanks,
Dscho

Quoted 3 lines

Thanks.

#24 lore raw

[PATCH 3/2] rebase -i: recognize short commands without arguments

In reply to Johannes Schindelin via GitGitGadget

The sequencer instruction 'b', short for 'break', is rejected:

error: invalid line 2: b

The reason is that the parser expects all short commands to have an argument. Permit short commands without arguments.

---
I'll send a another patch in a moment that tests all short sequencer commands, but it is independent from this topic.

 sequencer.c                | 3 ++-
 t/lib-rebase.sh            | 2 +-
 t/t3418-rebase-continue.sh | 4 +++-
 3 files changed, 6 insertions(+), 3 deletions(-)
sequencer.c +2 -1
index ee3961ec63..3107f59ea7 100644
@@ -1954,7 +1954,8 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 		if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
 			item->command = i;
 			break;
-		} else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
+		} else if ((bol + 1 == eol || bol[1] == ' ') &&
+			   *bol == todo_command_info[i].c) {
 			bol++;
 			item->command = i;
 			break;
t/lib-rebase.sh +1 -1
index 584604ee63..86572438ec 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*|break)
+		exec*|break|b)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +3 -1
index 185a491089..b282505aac 100755
@@ -243,7 +243,9 @@ unset GIT_SEQUENCE_EDITOR
 
 test_expect_success 'the todo command "break" works' '
 	rm -f execed &&
-	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	FAKE_LINES="break b exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
 	test_path_is_missing execed &&
 	git rebase --continue &&
 	test_path_is_file execed
Signature · 1 line
2.19.1.406.g1aa3f475f3
#25 lore raw

Re: [PATCH 3/2] rebase -i: recognize short commands without arguments

Quoted 49 lines · Johannes Sixt

The sequencer instruction 'b', short for 'break', is rejected:

error: invalid line 2: b

The reason is that the parser expects all short commands to have an argument. Permit short commands without arguments.

---
I'll send a another patch in a moment that tests all short sequencer commands, but it is independent from this topic.

 sequencer.c                | 3 ++-
 t/lib-rebase.sh            | 2 +-
 t/t3418-rebase-continue.sh | 4 +++-
 3 files changed, 6 insertions(+), 3 deletions(-)
sequencer.c +2 -1
index ee3961ec63..3107f59ea7 100644
@@ -1954,7 +1954,8 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 		if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
 			item->command = i;
 			break;
-		} else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
+		} else if ((bol + 1 == eol || bol[1] == ' ') &&
+			   *bol == todo_command_info[i].c) {
 			bol++;
 			item->command = i;
 			break;
t/lib-rebase.sh +1 -1
index 584604ee63..86572438ec 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*|break)
+		exec*|break|b)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +0 -0
index 185a491089..b282505aac 100755

t/t3418-rebase-continue.sh unset GIT_SEQUENCE_EDITOR · line 247

Quoted 6 lines
t/t3418-rebase-continue.sh +2 -1
@@ -243,7 +243,9 @@ unset GIT_SEQUENCE_EDITOR
 
 test_expect_success 'the todo command "break" works' '
 	rm -f execed &&
-	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	FAKE_LINES="break b exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&

When first 'break' hits, "git rebase -i" shouldn't have exited with non-zero, and we get to see if execed is there (it shouldn't exist yet).

t/t3418-rebase-continue.sh unset GIT_SEQUENCE_EDITOR · line 248

Quoted 1 line
t/t3418-rebase-continue.sh +1 -0
+	git rebase --continue &&

And then we continue, to hit the next 'b', which shouldn't barf, either, and then

t/t3418-rebase-continue.sh unset GIT_SEQUENCE_EDITOR · line 249

Quoted 1 line
t/t3418-rebase-continue.sh +0 -0
 	test_path_is_missing execed &&

we make sure execed is not yet there, before continuing out of that that 'b'roken state

t/t3418-rebase-continue.sh unset GIT_SEQUENCE_EDITOR · line 250

Quoted 1 line
t/t3418-rebase-continue.sh +0 -0
 	git rebase --continue &&

and then we'll hit the exec to create that file.

t/t3418-rebase-continue.sh unset GIT_SEQUENCE_EDITOR · line 251

Quoted 1 line
t/t3418-rebase-continue.sh +0 -0
 	test_path_is_file execed

Makes sense. Thanks.

#26 lore raw

Re: [PATCH 3/2] rebase -i: recognize short commands without arguments

In reply to Johannes Sixt

Hi Hannes,

Quoted 9 lines · Johannes Sixt

The sequencer instruction 'b', short for 'break', is rejected:

error: invalid line 2: b

The reason is that the parser expects all short commands to have an argument. Permit short commands without arguments.

---

ACK.

Thanks for fixing this,
Dscho

Quoted 53 lines

I'll send a another patch in a moment that tests all short sequencer commands, but it is independent from this topic.

 sequencer.c                | 3 ++-
 t/lib-rebase.sh            | 2 +-
 t/t3418-rebase-continue.sh | 4 +++-
 3 files changed, 6 insertions(+), 3 deletions(-)
sequencer.c +2 -1
index ee3961ec63..3107f59ea7 100644
@@ -1954,7 +1954,8 @@ static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
 		if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
 			item->command = i;
 			break;
-		} else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
+		} else if ((bol + 1 == eol || bol[1] == ' ') &&
+			   *bol == todo_command_info[i].c) {
 			bol++;
 			item->command = i;
 			break;
t/lib-rebase.sh +1 -1
index 584604ee63..86572438ec 100644
@@ -49,7 +49,7 @@ set_fake_editor () {
 		case $line in
 		squash|fixup|edit|reword|drop)
 			action="$line";;
-		exec*|break)
+		exec*|break|b)
 			echo "$line" | sed 's/_/ /g' >> "$1";;
 		"#")
 			echo '# comment' >> "$1";;
t/t3418-rebase-continue.sh +3 -1
index 185a491089..b282505aac 100755
@@ -243,7 +243,9 @@ unset GIT_SEQUENCE_EDITOR
 
 test_expect_success 'the todo command "break" works' '
 	rm -f execed &&
-	FAKE_LINES="break exec_>execed" git rebase -i HEAD &&
+	FAKE_LINES="break b exec_>execed" git rebase -i HEAD &&
+	test_path_is_missing execed &&
+	git rebase --continue &&
 	test_path_is_missing execed &&
 	git rebase --continue &&
 	test_path_is_file execed
Signature · 1 line
2.19.1.406.g1aa3f475f3