At the center of the "interactive" part of the interactive rebase lies
the todo list. When the user starts an interactive rebase, a todo list
is generated, presented to the user (who then edits it using a text
editor), read back, and then is checked and processed before the actual
rebase takes place.
Some of this processing includes adding execs commands, reordering
fixup! and squash! commits, and checking if no commits were accidentally
dropped by the user.
Before I converted the interactive rebase in C, these functions were
called by git-rebase--interactive.sh through git-rebase--helper. Since
the only way to pass around a large amount of data between a shell
script and a C program is to use a file (or any declination of a file),
the functions that checked and processed the todo list were directly
working on a file, the same file that the user edited.
During the conversion, I did not address this issue, which lead to a
complete_action() that reads the todo list file, does some computation
based on its content, and writes it back to the disk, several times in
the same function.
As it is not an efficient way to handle a data structure, this patch
series refactor the functions that processes the todo list to work on a
todo_list structure instead of reading it from the disk.
Some commits consists in modifying edit_todo_list() (initially used by
--edit-todo) to handle the initial edition of the todo list, to increase
code sharing.
This is based on nd/the-index (cde555480b, "Merge branch
'nd/the-index'").
Changes since v7:
- Add some comments to clarify some assumptions.
- Use `string_list_remove_empty_items()` instead of `--commands.nr` to
remove empty commands.
- Split the last commit ("rebase--interactive: move several functions
to rebase--interactive.c") into three, one for each function.
The tip of this series is tagged as "refactor-todo-list-v8" in
https://github.com/agrn/git.
The range diff is included below.
Alban Gruin (18):
sequencer: changes in parse_insn_buffer()
sequencer: make the todo_list structure public
sequencer: remove the 'arg' field from todo_item
sequencer: refactor transform_todos() to work on a todo_list
sequencer: introduce todo_list_write_to_file()
sequencer: refactor check_todo_list() to work on a todo_list
sequencer: refactor sequencer_add_exec_commands() to work on a
todo_list
sequencer: refactor rearrange_squash() to work on a todo_list
sequencer: make sequencer_make_script() write its script to a strbuf
sequencer: change complete_action() to use the refactored functions
rebase--interactive: move sequencer_add_exec_commands()
rebase--interactive: move rearrange_squash_in_todo_file()
sequencer: refactor skip_unnecessary_picks() to work on a todo_list
rebase-interactive: use todo_list_write_to_file() in edit_todo_list()
rebase-interactive: append_todo_help() changes
rebase-interactive: rewrite edit_todo_list() to handle the initial
edit
sequencer: use edit_todo_list() in complete_action()
rebase--interactive: move transform_todo_file()
builtin/rebase--interactive.c | 144 ++++++--
rebase-interactive.c | 146 ++++++--
rebase-interactive.h | 9 +-
sequencer.c | 655 ++++++++++++----------------------
sequencer.h | 81 ++++-
5 files changed, 553 insertions(+), 482 deletions(-)
Range-diff against v7:
1: 0bc5f714e5 = 1: 0bc5f714e5 sequencer: changes in parse_insn_buffer()
2: 34d149ff25 = 2: 34d149ff25 sequencer: make the todo_list structure public
3: 8200f7a6be = 3: 8200f7a6be sequencer: remove the 'arg' field from todo_item
4: ce8ca23ee0 = 4: ce8ca23ee0 sequencer: refactor transform_todos() to work on a todo_list
5: 67ebea475e = 5: 67ebea475e sequencer: introduce todo_list_write_to_file()
6: 370c153ebe = 6: 370c153ebe sequencer: refactor check_todo_list() to work on a todo_list
7: 66e7b65509 ! 7: 95ae0f36d2 sequencer: refactor sequencer_add_exec_commands() to work on a todo_list
@@ -60,7 +60,10 @@
+ if (cmd && *cmd) {
+ string_list_split(&commands, cmd, '\n', -1);
-+ --commands.nr;
++
++ /* rebase.c adds a new line to cmd after every command,
++ * so here the last command is always empty */
++ string_list_remove_empty_items(&commands, 0);
+ }
+
switch (command) {
@@ -86,7 +89,7 @@
BUG("invalid command '%d'", command);
}
-+ string_list_clear(&commands, 1);
++ string_list_clear(&commands, 0);
return !!ret;
}
@@ -133,9 +136,16 @@
}
/*
-@@
+ * Insert <commands> after every pick. Here, fixup/squash chains
* are considered part of the pick, so we insert the commands *after*
* those chains if there are any.
++ *
++ * As we insert the exec commands immediatly after rearranging
++ * any fixups and before the user edits the list, a fixup chain
++ * can never contain comments (any comments are empty picks that
++ * have been commented out because the user did not specify
++ * --keep-empty). So, it is safe to insert an exec command
++ * without looking at the command following a comment.
*/
- insert = -1;
- for (i = 0; i < todo_list.nr; i++) {
@@ -165,12 +175,11 @@
+ insert = 0;
}
-- if (command == TODO_PICK || command == TODO_MERGE)
-- insert = i + 1;
+ ALLOC_GROW(items, nr + 1, alloc);
+ items[nr++] = todo_list->items[i];
+
-+ if (command == TODO_PICK || command == TODO_MERGE || is_fixup(command))
+ if (command == TODO_PICK || command == TODO_MERGE)
+- insert = i + 1;
+ insert = 1;
}
@@ -192,8 +201,7 @@
+ todo_list->nr = nr;
+ todo_list->alloc = alloc;
+}
-
-- i = write_message(buf->buf, buf->len, todo_file, 0);
++
+int sequencer_add_exec_commands(struct repository *r,
+ struct string_list *commands)
+{
@@ -203,7 +211,8 @@
+
+ if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
+ return error_errno(_("could not read '%s'."), todo_file);
-+
+
+- i = write_message(buf->buf, buf->len, todo_file, 0);
+ if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
+ todo_list_release(&todo_list);
+ return error(_("unusable todo list: '%s'"), todo_file);
8: 640cb7aa54 = 8: 144eb32743 sequencer: refactor rearrange_squash() to work on a todo_list
9: bef1970c88 = 9: 1501c26317 sequencer: make sequencer_make_script() write its script to a strbuf
10: 48ee37a32a = 10: 121b270c4d sequencer: change complete_action() to use the refactored functions
16: f57a7405d0 ! 11: a3763ecb0e rebase--interactive: move several functions to rebase--interactive.c
@@ -1,13 +1,12 @@
Author: Alban Gruin <alban.gruin@xxxxxxxxx>
- rebase--interactive: move several functions to rebase--interactive.c
+ rebase--interactive: move sequencer_add_exec_commands()
- As sequencer_add_exec_commands(), rearrange_squash_in_todo_file(), and
- transform_todo_file() are only needed inside of rebase--interactive.c
- for rebase -p, they are moved there from sequencer.c.
+ As sequencer_add_exec_commands() is only needed inside of
+ rebase--interactive.c for `rebase -p', it is moved there from
+ sequencer.c.
- The parameter r (repository) is dropped from them, and the error
- handling of rearrange_squash_in_todo_file() is slightly improved.
+ The parameter r (repository) is dropped along the way.
Signed-off-by: Alban Gruin <alban.gruin@xxxxxxxxx>
@@ -43,72 +42,11 @@
+ return 0;
+}
+
-+static int rearrange_squash_in_todo_file(void)
-+{
-+ const char *todo_file = rebase_path_todo();
-+ struct todo_list todo_list = TODO_LIST_INIT;
-+ int res = 0;
-+
-+ if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-+ return error_errno(_("could not read '%s'."), todo_file);
-+ if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
-+ &todo_list)) {
-+ todo_list_release(&todo_list);
-+ return error(_("unusable todo list: '%s'"), todo_file);
-+ }
-+
-+ res = todo_list_rearrange_squash(&todo_list);
-+ if (!res)
-+ res = todo_list_write_to_file(the_repository, &todo_list,
-+ todo_file, NULL, NULL, -1, 0);
-+
-+ todo_list_release(&todo_list);
-+
-+ if (res)
-+ return error_errno(_("could not write '%s'."), todo_file);
-+ return 0;
-+}
-+
-+static int transform_todo_file(unsigned flags)
-+{
-+ const char *todo_file = rebase_path_todo();
-+ struct todo_list todo_list = TODO_LIST_INIT;
-+ int res;
-+
-+ if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-+ return error_errno(_("could not read '%s'."), todo_file);
-+
-+ if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
-+ &todo_list)) {
-+ todo_list_release(&todo_list);
-+ return error(_("unusable todo list: '%s'"), todo_file);
-+ }
-+
-+ res = todo_list_write_to_file(the_repository, &todo_list, todo_file,
-+ NULL, NULL, -1, flags);
-+ todo_list_release(&todo_list);
-+
-+ if (res)
-+ return error_errno(_("could not write '%s'."), todo_file);
-+ return 0;
-+}
-+
- static int edit_todo_file(unsigned flags)
- {
- const char *todo_file = rebase_path_todo();
+ static int get_revision_ranges(const char *upstream, const char *onto,
+ const char **head_hash,
+ char **revisions, char **shortrevisions)
@@
- }
- case SHORTEN_OIDS:
- case EXPAND_OIDS:
-- ret = transform_todo_file(the_repository, flags);
-+ ret = transform_todo_file(flags);
- break;
- case CHECK_TODO_LIST:
- ret = check_todo_list_from_file(the_repository);
- break;
- case REARRANGE_SQUASH:
-- ret = rearrange_squash_in_todo_file(the_repository);
-+ ret = rearrange_squash_in_todo_file();
+ ret = rearrange_squash_in_todo_file(the_repository);
break;
case ADD_EXEC:
- ret = sequencer_add_exec_commands(the_repository, &commands);
@@ -162,82 +100,6 @@
static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
struct strbuf *buf, int num, unsigned flags)
{
-@@
- return res;
- }
-
--int transform_todo_file(struct repository *r, unsigned flags)
--{
-- const char *todo_file = rebase_path_todo();
-- struct todo_list todo_list = TODO_LIST_INIT;
-- int res;
--
-- if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-- return error_errno(_("could not read '%s'."), todo_file);
--
-- if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
-- todo_list_release(&todo_list);
-- return error(_("unusable todo list: '%s'"), todo_file);
-- }
--
-- res = todo_list_write_to_file(r, &todo_list, todo_file,
-- NULL, NULL, -1, flags);
-- todo_list_release(&todo_list);
--
-- if (res)
-- return error_errno(_("could not write '%s'."), todo_file);
-- return 0;
--}
--
- static const char edit_todo_list_advice[] =
- N_("You can fix this with 'git rebase --edit-todo' "
- "and then run 'git rebase --continue'.\n"
-@@
- return 0;
- }
-
--static int todo_list_rearrange_squash(struct todo_list *todo_list);
--
- int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
- const char *shortrevisions, const char *onto_name,
- const char *onto, const char *orig_head, struct string_list *commands,
-@@
- * message will have to be retrieved from the commit (as the oneline in the
- * script cannot be trusted) in order to normalize the autosquash arrangement.
- */
--static int todo_list_rearrange_squash(struct todo_list *todo_list)
-+int todo_list_rearrange_squash(struct todo_list *todo_list)
- {
- struct hashmap subject2item;
- int rearranged = 0, *next, *tail, i, nr = 0, alloc = 0;
-@@
-
- return 0;
- }
--
--int rearrange_squash_in_todo_file(struct repository *r)
--{
-- const char *todo_file = rebase_path_todo();
-- struct todo_list todo_list = TODO_LIST_INIT;
-- int res = 0;
--
-- if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
-- return -1;
-- if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
-- todo_list_release(&todo_list);
-- return -1;
-- }
--
-- res = todo_list_rearrange_squash(&todo_list);
-- if (!res)
-- res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1, 0);
--
-- todo_list_release(&todo_list);
--
-- if (res)
-- return error_errno(_("could not write '%s'."), todo_file);
-- return 0;
--}
diff --git a/sequencer.h b/sequencer.h
--- a/sequencer.h
@@ -248,16 +110,9 @@
-int sequencer_add_exec_commands(struct repository *r,
- struct string_list *commands);
--int transform_todo_file(struct repository *r, unsigned flags);
+ int transform_todo_file(struct repository *r, unsigned flags);
+void todo_list_add_exec_commands(struct todo_list *todo_list,
+ struct string_list *commands);
int check_todo_list_from_file(struct repository *r);
int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
const char *shortrevisions, const char *onto_name,
- const char *onto, const char *orig_head, struct string_list *commands,
- unsigned autosquash, struct todo_list *todo_list);
--int rearrange_squash_in_todo_file(struct repository *r);
-+int todo_list_rearrange_squash(struct todo_list *todo_list);
-
- extern const char sign_off_header[];
-
-: ---------- > 12: e03663ed04 rebase--interactive: move rearrange_squash_in_todo_file()
11: bc89fbfea6 = 13: d9cf3d7d2f sequencer: refactor skip_unnecessary_picks() to work on a todo_list
12: a754d0da96 = 14: bf6cc5978c rebase-interactive: use todo_list_write_to_file() in edit_todo_list()
13: 031e4de856 = 15: 1c9d1cb3c9 rebase-interactive: append_todo_help() changes
14: 268998924b ! 16: b98b07dae0 rebase-interactive: rewrite edit_todo_list() to handle the initial edit
@@ -16,8 +16,8 @@
--- a/builtin/rebase--interactive.c
+++ b/builtin/rebase--interactive.c
@@
- static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
- static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
+ return 0;
+ }
+static int edit_todo_file(unsigned flags)
+{
@@ -87,6 +87,9 @@
- todo_list_release(&todo_list);
- return -1;
- }
++ /* If the user is editing the todo list, we first try to parse
++ * it. If there is an error, we do not return, because the user
++ * might want to fix it in the first place. */
+ if (!initial)
+ todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
@@ -110,6 +113,8 @@
+ if (initial && new_todo->buf.len == 0)
+ return -3;
+
++ /* For the initial edit, the todo list gets parsed in
++ * complete_action(). */
+ if (!initial)
+ return todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);
+
15: 6f1274a33c = 17: 406e971e56 sequencer: use edit_todo_list() in complete_action()
-: ---------- > 18: 51d44a8200 rebase--interactive: move transform_todo_file()
--
2.20.1
