Skip to contentSkip to conversation

sequencer: refactor functions working on a todo_list

PATCH Superseded Alban Gruin 6 participants 190 messages Oct 7, 2018 – Mar 13, 2019 Page 2 of 2

lore
Share & tools
lore
#123 lore raw

Re: [PATCH v6 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

In reply to Phillip Wood

Hi Phillip,

Le 31/01/2019 à 15:30, Phillip Wood a écrit :

Quoted 71 lines

Hi Alban

Quoted 68 lines · Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created.  Items from the old list are copied across and new `exec' items are appended when necessary.  This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command.  This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  15 +++--
 sequencer.c                   | 110 +++++++++++++++++++++------------- sequencer.h                   |   5 +-

 3 files changed, 82 insertions(+), 48 deletions(-)
builtin/rebase--interactive.c +1 -1
index df19ccaeb9..53056ee713 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts
 *opts, unsigned flags,
                   const char *onto, const char *onto_name,
                   const char *squash_onto, const char *head_name,
                   const char *restrict_revision, char *raw_strategies,
-                 const char *cmd, unsigned autosquash)
+                 struct string_list *commands, unsigned autosquash)
  {
      int ret;

     const char *head_hash = NULL;

builtin/rebase--interactive.c +1 -1
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct
 replay_opts *opts, unsigned flags,
          discard_cache();
          ret = complete_action(the_repository, opts, flags,
                        shortrevisions, onto_name, onto,
-                      head_hash, cmd, autosquash);
+                      head_hash, commands, autosquash);
      }


     free(revisions);

builtin/rebase--interactive.c +0 -0
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)

     const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
         *squash_onto = NULL, *upstream = NULL, *head_name = NULL, *switch_to = NULL, *cmd = NULL;
+    struct string_list commands = STRING_LIST_INIT_DUP; char *raw_strategies = NULL;
     enum {
         NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,

builtin/rebase--interactive.c +0 -0
@@ -221,6 +222,12 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)

         warning(_("--[no-]rebase-cousins has no effect without " "--rebase-merges"));

Quoted 9 lines
Quoted 2 lines

+    if (cmd && *cmd) {
+        string_list_split(&commands, cmd, '\n', -1);

This whole splitting and later skipping 'exec ' is a bit of a shame - it would be much nicer if we could just have one exec command per -x option but I think that is outside the scope of this series (If I have time I'd like to look at calling do_interactive_rebase() directly from builtin/rebase.c without forking rebase--interactive).

Yes, I completely agree with you. I thought to do this in preparation to drop rebase -r.

Quoted 5 lines
Quoted 1 line

+        if (strlen(commands.items[commands.nr - 1].string) == 0)

I'd be tempted just to test the string using !* rather than calling strlen.

Right. I’m still not used to this pattern.

Quoted 1 line

Also is there ever a case where the last string isn't empty?

I don’t think so. When rebase.c prepares the arguments for rebase--interactive, it always add a newline at the end[1]. Do you want me to drop this check?

Quoted 108 lines
Quoted 86 lines

+            --commands.nr;
+    }
+
     switch (command) {
     case NONE:
         if (!onto && !upstream)

builtin/rebase--interactive.c +0 -0
@@ -228,7 +235,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)


         ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
                         onto_name, squash_onto, head_name, restrict_revision,
-                        raw_strategies, cmd, autosquash); +                        raw_strategies, &commands, autosquash); break;
     case SKIP: {
         struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c +0 -0
@@ -262,7 +269,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
          ret = rearrange_squash(the_repository);
          break;

     case ADD_EXEC:
-        ret = sequencer_add_exec_commands(the_repository, cmd); +        ret = sequencer_add_exec_commands(the_repository, &commands); break;
     default:
         BUG("invalid command '%d'", command);

sequencer.c +0 -0
index 266f80d704..3a90b419d7 100644
@@ -4446,25 +4446,27 @@ int sequencer_make_script(struct repository
 *r, FILE *out,
      return 0;
  }

sequencer.c +2 -6
-/*
- * Add commands after pick and (series of) squash/fixup commands
- * in the todo list.
- */
-int sequencer_add_exec_commands(struct repository *r,
-                const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+                    struct string_list *commands)

 {
-    const char *todo_file = rebase_path_todo();
-    struct todo_list todo_list = TODO_LIST_INIT;
-    struct strbuf *buf = &todo_list.buf;
-    size_t offset = 0, commands_len = strlen(commands);
-    int i, insert;
+    struct strbuf *buf = &todo_list->buf;
+    size_t base_offset = buf->len;
+    int i, insert, nr = 0, alloc = 0;
+    struct todo_item *items = NULL, *base_items = NULL;

-    if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0) -        return error(_("could not read '%s'."), todo_file); +    base_items = xcalloc(commands->nr, sizeof(struct todo_item)); +    for (i = 0; i < commands->nr; ++i) {
+        size_t command_len = strlen(commands->items[i].string);
-    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); +        strbuf_addstr(buf, commands->items[i].string);
+        strbuf_addch(buf, '\n');

sequencer.c +7 -0
+
+        base_items[i].command = TODO_EXEC;
+        base_items[i].offset_in_buf = base_offset;
+        base_items[i].arg_offset = base_offset + strlen("exec ");
+        base_items[i].arg_len = command_len - strlen("exec ");
+
+        base_offset += command_len + 1;

     }

     /*

sequencer.c +0 -4
@@ -4473,38 +4475,62 @@ int sequencer_add_exec_commands(struct
 repository *r,
       * those chains if there are any.
       */
      insert = -1;
-    for (i = 0; i < todo_list.nr; i++) {
-        enum todo_command command = todo_list.items[i].command;
-
-        if (insert >= 0) {

sequencer.c int sequencer_add_exec_commands(struct · line 4490

Quoted 10 lines
sequencer.c +0 -10
-            /* skip fixup/squash chains */
-            if (command == TODO_COMMENT)
-                continue;
-            else if (is_fixup(command)) {
-                insert = i + 1;
-                continue;
-            }
-            strbuf_insert(buf,
-                      todo_list.items[insert].offset_in_buf +
-                      offset, commands, commands_len);

In a todo list that looks like
pick abc message
#pick cde empty commit
This inserts the exec command for the first pick above the commented out pick. I think your translation puts it below the commented out pick as it ignores the value of insert. I think it's probably easiest to add an INSERT_ARRAY macro to insert it in the right place. An alternative might be to track the last insert position and only copy commands across when there is another exec to insert but that might get complicated in cases such as

Quoted 5 lines

pick abc message
#squash cde squash! message //empty commit for rewording fixup 123 fixup! message
#pick 456 empty commit

I could do this with MOVE_ARRAY(), no?

Quoted 4 lines

Best Wishes

Phillip

[1] https://github.com/git/git/blob/master/builtin/rebase.c#L1182-L1191

Cheers,
Alban

#124 lore raw

Re: [PATCH v6 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

Hi Alban

Quoted 93 lines · Alban Gruin

Hi Phillip,

Le 31/01/2019 à 15:30, Phillip Wood a écrit :

Quoted 71 lines

Hi Alban

Quoted 68 lines · Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created.  Items from the old list are copied across and new `exec' items are appended when necessary.  This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command.  This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
  builtin/rebase--interactive.c |  15 +++--
  sequencer.c                   | 110 +++++++++++++++++++++-------------
  sequencer.h                   |   5 +-
  3 files changed, 82 insertions(+), 48 deletions(-)
builtin/rebase--interactive.c +1 -1
index df19ccaeb9..53056ee713 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts
 *opts, unsigned flags,
                   const char *onto, const char *onto_name,
                   const char *squash_onto, const char *head_name,
                   const char *restrict_revision, char *raw_strategies,
-                 const char *cmd, unsigned autosquash)
+                 struct string_list *commands, unsigned autosquash)
  {
      int ret;

     const char *head_hash = NULL;

builtin/rebase--interactive.c +1 -1
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct
 replay_opts *opts, unsigned flags,
          discard_cache();
          ret = complete_action(the_repository, opts, flags,
                        shortrevisions, onto_name, onto,
-                      head_hash, cmd, autosquash);
+                      head_hash, commands, autosquash);
      }
 

     free(revisions);

builtin/rebase--interactive.c +1 -0
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
      const char *onto = NULL, *onto_name = NULL, *restrict_revision =
 NULL,
          *squash_onto = NULL, *upstream = NULL, *head_name = NULL,
          *switch_to = NULL, *cmd = NULL;
+    struct string_list commands = STRING_LIST_INIT_DUP;
      char *raw_strategies = NULL;

     enum {
         NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,

builtin/rebase--interactive.c +0 -0
@@ -221,6 +222,12 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
          warning(_("--[no-]rebase-cousins has no effect without "
                "--rebase-merges"));
 
Quoted 9 lines

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 226

Quoted 2 lines
builtin/rebase--interactive.c +2 -0
+    if (cmd && *cmd) {
+        string_list_split(&commands, cmd, '\n', -1);

This whole splitting and later skipping 'exec ' is a bit of a shame - it would be much nicer if we could just have one exec command per -x option but I think that is outside the scope of this series (If I have time I'd like to look at calling do_interactive_rebase() directly from builtin/rebase.c without forking rebase--interactive).

Yes, I completely agree with you. I thought to do this in preparation to drop rebase -r.

Quoted 5 lines

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 227

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+        if (strlen(commands.items[commands.nr - 1].string) == 0)

I'd be tempted just to test the string using !* rather than calling strlen.

Quoted 7 lines

Right. I’m still not used to this pattern.

Quoted 1 line

Also is there ever a case where the last string isn't empty?

I don’t think so. When rebase.c prepares the arguments for rebase--interactive, it always add a newline at the end[1]. Do you want me to drop this check?

I think that would be clearer

Quoted 110 lines
Quoted 110 lines
Quoted 88 lines
builtin/rebase--interactive.c +3 -0
+            --commands.nr;
+    }
+
      switch (command) {
      case NONE:

         if (!onto && !upstream)

builtin/rebase--interactive.c +1 -1
@@ -228,7 +235,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
 
          ret = do_interactive_rebase(&opts, flags, switch_to,
 upstream, onto,
                          onto_name, squash_onto, head_name,
 restrict_revision,
-                        raw_strategies, cmd, autosquash);
+                        raw_strategies, &commands, autosquash);

         break;
     case SKIP: {
         struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c +1 -1
@@ -262,7 +269,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
          ret = rearrange_squash(the_repository);
          break;
      case ADD_EXEC:
-        ret = sequencer_add_exec_commands(the_repository, cmd);
+        ret = sequencer_add_exec_commands(the_repository, &commands);
          break;
      default:

         BUG("invalid command '%d'", command);

sequencer.c +18 -16
index 266f80d704..3a90b419d7 100644
@@ -4446,25 +4446,27 @@ int sequencer_make_script(struct repository
 *r, FILE *out,
      return 0;
  }
 
-/*
- * Add commands after pick and (series of) squash/fixup commands
- * in the todo list.
- */
-int sequencer_add_exec_commands(struct repository *r,
-                const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+                    struct string_list *commands)
  {
-    const char *todo_file = rebase_path_todo();
-    struct todo_list todo_list = TODO_LIST_INIT;
-    struct strbuf *buf = &todo_list.buf;
-    size_t offset = 0, commands_len = strlen(commands);
-    int i, insert;
+    struct strbuf *buf = &todo_list->buf;
+    size_t base_offset = buf->len;
+    int i, insert, nr = 0, alloc = 0;
+    struct todo_item *items = NULL, *base_items = NULL;
 
-    if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-        return error(_("could not read '%s'."), todo_file);
+    base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+    for (i = 0; i < commands->nr; ++i) {
+        size_t command_len = strlen(commands->items[i].string);
 
-    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);
+        strbuf_addstr(buf, commands->items[i].string);
+        strbuf_addch(buf, '\n');
+
+        base_items[i].command = TODO_EXEC;
+        base_items[i].offset_in_buf = base_offset;
+        base_items[i].arg_offset = base_offset + strlen("exec ");
+        base_items[i].arg_len = command_len - strlen("exec ");
+
+        base_offset += command_len + 1;
      }
 

     /*

sequencer.c +0 -4
@@ -4473,38 +4475,62 @@ int sequencer_add_exec_commands(struct
 repository *r,
       * those chains if there are any.
       */
      insert = -1;
-    for (i = 0; i < todo_list.nr; i++) {
-        enum todo_command command = todo_list.items[i].command;
-
-        if (insert >= 0) {

sequencer.c int sequencer_add_exec_commands(struct · line 4490

Quoted 10 lines
sequencer.c +0 -10
-            /* skip fixup/squash chains */
-            if (command == TODO_COMMENT)
-                continue;
-            else if (is_fixup(command)) {
-                insert = i + 1;
-                continue;
-            }
-            strbuf_insert(buf,
-                      todo_list.items[insert].offset_in_buf +
-                      offset, commands, commands_len);

In a todo list that looks like
pick abc message
#pick cde empty commit
This inserts the exec command for the first pick above the commented out pick. I think your translation puts it below the commented out pick as it ignores the value of insert. I think it's probably easiest to add an INSERT_ARRAY macro to insert it in the right place. An alternative might be to track the last insert position and only copy commands across when there is another exec to insert but that might get complicated in cases such as

Quoted 7 lines
Quoted 5 lines

pick abc message
#squash cde squash! message //empty commit for rewording fixup 123 fixup! message
#pick 456 empty commit

I could do this with MOVE_ARRAY(), no?

Yes, if you extend the array first then you could use MOVE_ARRAY() and COPY_ARRAY() to move the comment down and then insert the exec commands so maybe we don't need a new macro after all.

I've looked through most of the rest of this series (I think I've got three patches left to check) and they all look fine, I'll try and look at the rest tomorrow, but if not I'll get round to it next week.

Best Wishes

Phillip

Quoted 11 lines
Quoted 4 lines

Best Wishes

Phillip

[1] https://github.com/git/git/blob/master/builtin/rebase.c#L1182-L1191

Cheers,
Alban

#125 lore raw

Re: [PATCH v6 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

In reply to Phillip Wood
Quoted 178 lines · Phillip Wood

Hi Alban

Quoted 66 lines · Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created.  Items from the old list are copied across and new `exec' items are appended when necessary.  This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command.  This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  15 +++--
 sequencer.c                   | 110 +++++++++++++++++++++------------- sequencer.h                   |   5 +-

 3 files changed, 82 insertions(+), 48 deletions(-)
builtin/rebase--interactive.c +1 -1
index df19ccaeb9..53056ee713 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts 
 *opts, unsigned flags,
                   const char *onto, const char *onto_name,
                   const char *squash_onto, const char *head_name,
                   const char *restrict_revision, char *raw_strategies,
-                 const char *cmd, unsigned autosquash)
+                 struct string_list *commands, unsigned autosquash)
  {
      int ret;

     const char *head_hash = NULL;

builtin/rebase--interactive.c +1 -1
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct 
 replay_opts *opts, unsigned flags,
          discard_cache();
          ret = complete_action(the_repository, opts, flags,
                        shortrevisions, onto_name, onto,
-                      head_hash, cmd, autosquash);
+                      head_hash, commands, autosquash);
      }
 

     free(revisions);

builtin/rebase--interactive.c +1 -0
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char 
 **argv, const char *prefix)
      const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
          *squash_onto = NULL, *upstream = NULL, *head_name = NULL,
          *switch_to = NULL, *cmd = NULL;
+    struct string_list commands = STRING_LIST_INIT_DUP;
      char *raw_strategies = NULL;
      enum {

         NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,

builtin/rebase--interactive.c +0 -0
@@ -221,6 +222,12 @@ int cmd_rebase__interactive(int argc, const char 
 **argv, const char *prefix)

         warning(_("--[no-]rebase-cousins has no effect without " "--rebase-merges"));

Quoted 2 lines

+    if (cmd && *cmd) {
+        string_list_split(&commands, cmd, '\n', -1);

This whole splitting and later skipping 'exec ' is a bit of a shame - it would be much nicer if we could just have one exec command per -x option but I think that is outside the scope of this series (If I have time I'd like to look at calling do_interactive_rebase() directly from builtin/rebase.c without forking rebase--interactive).

Quoted 1 line

+        if (strlen(commands.items[commands.nr - 1].string) == 0)

I'd be tempted just to test the string using !* rather than calling strlen. Also is there ever a case where the last string isn't empty?

Quoted 84 lines

+            --commands.nr;
+    }
+
     switch (command) {
     case NONE:
         if (!onto && !upstream)

builtin/rebase--interactive.c +1 -1
@@ -228,7 +235,7 @@ int cmd_rebase__interactive(int argc, const char 
 **argv, const char *prefix)
 
          ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
                          onto_name, squash_onto, head_name, restrict_revision,
-                        raw_strategies, cmd, autosquash);
+                        raw_strategies, &commands, autosquash);
          break;
      case SKIP: {

         struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c +0 -0
@@ -262,7 +269,7 @@ int cmd_rebase__interactive(int argc, const char 
 **argv, const char *prefix)
          ret = rearrange_squash(the_repository);
          break;

     case ADD_EXEC:
-        ret = sequencer_add_exec_commands(the_repository, cmd); +        ret = sequencer_add_exec_commands(the_repository, &commands); break;
     default:
         BUG("invalid command '%d'", command);

sequencer.c +18 -16
index 266f80d704..3a90b419d7 100644
@@ -4446,25 +4446,27 @@ int sequencer_make_script(struct repository 
 *r, FILE *out,
      return 0;
  }
 
-/*
- * Add commands after pick and (series of) squash/fixup commands
- * in the todo list.
- */
-int sequencer_add_exec_commands(struct repository *r,
-                const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+                    struct string_list *commands)
  {
-    const char *todo_file = rebase_path_todo();
-    struct todo_list todo_list = TODO_LIST_INIT;
-    struct strbuf *buf = &todo_list.buf;
-    size_t offset = 0, commands_len = strlen(commands);
-    int i, insert;
+    struct strbuf *buf = &todo_list->buf;
+    size_t base_offset = buf->len;
+    int i, insert, nr = 0, alloc = 0;
+    struct todo_item *items = NULL, *base_items = NULL;
 
-    if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-        return error(_("could not read '%s'."), todo_file);
+    base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+    for (i = 0; i < commands->nr; ++i) {
+        size_t command_len = strlen(commands->items[i].string);
 
-    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);
+        strbuf_addstr(buf, commands->items[i].string);
+        strbuf_addch(buf, '\n');
+
+        base_items[i].command = TODO_EXEC;
+        base_items[i].offset_in_buf = base_offset;
+        base_items[i].arg_offset = base_offset + strlen("exec ");
+        base_items[i].arg_len = command_len - strlen("exec ");
+
+        base_offset += command_len + 1;
      }
 

     /*

sequencer.c +0 -4
@@ -4473,38 +4475,62 @@ int sequencer_add_exec_commands(struct 
 repository *r,
       * those chains if there are any.
       */
      insert = -1;
-    for (i = 0; i < todo_list.nr; i++) {
-        enum todo_command command = todo_list.items[i].command;
-
-        if (insert >= 0) {

sequencer.c int sequencer_add_exec_commands(struct · line 4490

Quoted 10 lines
sequencer.c +0 -10
-            /* skip fixup/squash chains */
-            if (command == TODO_COMMENT)
-                continue;
-            else if (is_fixup(command)) {
-                insert = i + 1;
-                continue;
-            }
-            strbuf_insert(buf,
-                      todo_list.items[insert].offset_in_buf +
-                      offset, commands, commands_len);

In a todo list that looks like
pick abc message
#pick cde empty commit
This inserts the exec command for the first pick above the commented out pick. I think your translation puts it below the commented out pick as it ignores the value of insert. I think it's probably easiest to add an INSERT_ARRAY macro to insert it in the right place. An alternative might be to track the last insert position and only copy commands across when there is another exec to insert but that might get complicated in cases such as

Quoted 4 lines

pick abc message
#squash cde squash! message //empty commit for rewording fixup 123 fixup! message
#pick 456 empty commit

Thinking about this, I'm not sure it can happen as the empty squash commit will be commented out before rearrange_squash() is called so I think it would actually look like

pick abc message
fixup 123 fixup! message
#pick cde squash! message
#pick 456 empty commit

So I wonder if we can get away with treating insert as a flag and inserting exec commands when insert && command == TODO_COMMENT

We could probably do with some tests for this to be sure.

Best Wishes

Phillip

Quoted 123 lines

Best Wishes

Phillip

Quoted 117 lines
sequencer.c +46 -9
-            offset += commands_len;
+    for (i = 0; i < todo_list->nr; i++) {
+        enum todo_command command = todo_list->items[i].command;
+        if (insert >= 0 && command != TODO_COMMENT && 
 !is_fixup(command)) {
+            ALLOC_GROW(items, nr + commands->nr, alloc);
+            COPY_ARRAY(items + nr, base_items, commands->nr);
+            nr += commands->nr;
              insert = -1;
          }
 
-        if (command == TODO_PICK || command == TODO_MERGE)
+        ALLOC_GROW(items, nr + 1, alloc);
+        items[nr++] = todo_list->items[i];
+
+        if (command == TODO_PICK || command == TODO_MERGE || 
 is_fixup(command))
              insert = i + 1;
      }
 
      /* insert or append final <commands> */
-    if (insert >= 0 && insert < todo_list.nr)
-        strbuf_insert(buf, todo_list.items[insert].offset_in_buf +
-                  offset, commands, commands_len);
-    else if (insert >= 0 || !offset)
-        strbuf_add(buf, commands, commands_len);
+    if (insert >= 0 || nr == todo_list->nr) {
+        ALLOC_GROW(items, nr + commands->nr, alloc);
+        COPY_ARRAY(items + nr, base_items, commands->nr);
+        nr += commands->nr;
+    }
+
+    free(base_items);
+    FREE_AND_NULL(todo_list->items);
+    todo_list->items = items;
+    todo_list->nr = nr;
+    todo_list->alloc = alloc;> +}
 
-    i = write_message(buf->buf, buf->len, todo_file, 0);
+/*
+ * Add commands after pick and (series of) squash/fixup commands
+ * in the todo list.
+ */
+int sequencer_add_exec_commands(struct repository *r,
+                struct string_list *commands)
+{
+    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);
+    }
+
+    todo_list_add_exec_commands(&todo_list, commands);
+    res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, 
 NULL, -1, 0);
      todo_list_release(&todo_list);
-    return i;
+
+    if (res)
+        return error_errno(_("could not write '%s'."), todo_file);
+    return 0;

 }

 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,

sequencer.c +0 -0
@@ -4735,7 +4761,7 @@ static int skip_unnecessary_picks(struct 

repository *r, struct object_id *output

 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, const char *cmd, +            const char *onto, const char *orig_head, struct string_list *commands,
             unsigned autosquash)
 {
     const char *shortonto, *todo_file = rebase_path_todo();

sequencer.c +0 -0
@@ -4754,8 +4780,8 @@ int complete_action(struct repository *r, struct 

replay_opts *opts, unsigned fla
     if (autosquash && rearrange_squash(r))
         return -1;

-    if (cmd && *cmd)
-        sequencer_add_exec_commands(r, cmd); +    if (commands->nr)
+        sequencer_add_exec_commands(r, commands);

     if (strbuf_read_file(buf, todo_file, 0) < 0) return error_errno(_("could not read '%s'."), todo_file);

sequencer.h +3 -2
index 1de97f188d..e79f03e213 100644
@@ -146,12 +146,13 @@ int sequencer_make_script(struct repository *r, 
 FILE *out, int argc,
                const char **argv,
                unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r, const char 
 *command);
+int sequencer_add_exec_commands(struct repository *r,
+                struct string_list *commands);
  int transform_todo_file(struct repository *r, unsigned flags);
  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, const char *cmd,
+            const char *onto, const char *orig_head, struct 
 string_list *commands,

             unsigned autosquash);
 int rearrange_squash(struct repository *r);

#126 lore raw

Re: [PATCH v6 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

Le 01/02/2019 à 15:51, Phillip Wood a écrit :

Quoted 45 lines
Quoted 31 lines
Quoted 9 lines
sequencer.c +0 -4
@@ -4473,38 +4475,62 @@ int sequencer_add_exec_commands(struct
 repository *r,
       * those chains if there are any.
       */
      insert = -1;
-    for (i = 0; i < todo_list.nr; i++) {
-        enum todo_command command = todo_list.items[i].command;
-
-        if (insert >= 0) {

sequencer.c int sequencer_add_exec_commands(struct · line 4490

Quoted 10 lines
sequencer.c +0 -10
-            /* skip fixup/squash chains */
-            if (command == TODO_COMMENT)
-                continue;
-            else if (is_fixup(command)) {
-                insert = i + 1;
-                continue;
-            }
-            strbuf_insert(buf,
-                      todo_list.items[insert].offset_in_buf +
-                      offset, commands, commands_len);

In a todo list that looks like
pick abc message
#pick cde empty commit
This inserts the exec command for the first pick above the commented out pick. I think your translation puts it below the commented out pick as it ignores the value of insert. I think it's probably easiest to add an INSERT_ARRAY macro to insert it in the right place. An alternative might be to track the last insert position and only copy commands across when there is another exec to insert but that might get complicated in cases such as

Quoted 4 lines

pick abc message
#squash cde squash! message //empty commit for rewording fixup 123 fixup! message
#pick 456 empty commit

Thinking about this, I'm not sure it can happen as the empty squash commit will be commented out before rearrange_squash() is called so I think it would actually look like

pick abc message
fixup 123 fixup! message
#pick cde squash! message
#pick 456 empty commit

Quoted 6 lines

So I wonder if we can get away with treating insert as a flag and inserting exec commands when
insert && command == TODO_COMMENT

We could probably do with some tests for this to be sure.

I will try this approach.

-- Alban

Quoted 4 lines

Best Wishes

Phillip

#127 lore raw

Re: [PATCH v6 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

In reply to Alban Gruin

Hi Alban

Quoted 51 lines · Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created. Items from the old list are copied across and new `exec' items are appended when necessary. This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command. This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  15 +++--
 sequencer.c                   | 110 +++++++++++++++++++++-------------
 sequencer.h                   |   5 +-
 3 files changed, 82 insertions(+), 48 deletions(-)
builtin/rebase--interactive.c +2 -2
index df19ccaeb9..53056ee713 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 				 const char *onto, const char *onto_name,
 				 const char *squash_onto, const char *head_name,
 				 const char *restrict_revision, char *raw_strategies,
-				 const char *cmd, unsigned autosquash)
+				 struct string_list *commands, unsigned autosquash)
 {
 	int ret;
 	const char *head_hash = NULL;
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 		discard_cache();
 		ret = complete_action(the_repository, opts, flags,
 				      shortrevisions, onto_name, onto,
-				      head_hash, cmd, autosquash);
+				      head_hash, commands, autosquash);
 	}
 
 	free(revisions);

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 142

Quoted 4 lines
builtin/rebase--interactive.c +1 -0
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
 		*squash_onto = NULL, *upstream = NULL, *head_name = NULL,
 		*switch_to = NULL, *cmd = NULL;
+	struct string_list commands = STRING_LIST_INIT_DUP;

This is leaked, I think we should call string_list_clear() at the end.

Best Wishes

Phillip

Quoted 209 lines
builtin/rebase--interactive.c +8 -2
 	char *raw_strategies = NULL;
 	enum {
 		NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,
@@ -221,6 +222,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);
+		if (strlen(commands.items[commands.nr - 1].string) == 0)
+			--commands.nr;
+	}
+
 	switch (command) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +235,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;
@@ -262,7 +269,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
sequencer.c +68 -42
index 266f80d704..3a90b419d7 100644
@@ -4446,25 +4446,27 @@ int sequencer_make_script(struct repository *r, FILE *out,
 	return 0;
 }
 
-/*
- * Add commands after pick and (series of) squash/fixup commands
- * in the todo list.
- */
-int sequencer_add_exec_commands(struct repository *r,
-				const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+					struct string_list *commands)
 {
-	const char *todo_file = rebase_path_todo();
-	struct todo_list todo_list = TODO_LIST_INIT;
-	struct strbuf *buf = &todo_list.buf;
-	size_t offset = 0, commands_len = strlen(commands);
-	int i, insert;
+	struct strbuf *buf = &todo_list->buf;
+	size_t base_offset = buf->len;
+	int i, insert, nr = 0, alloc = 0;
+	struct todo_item *items = NULL, *base_items = NULL;
 
-	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-		return error(_("could not read '%s'."), todo_file);
+	base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+	for (i = 0; i < commands->nr; ++i) {
+		size_t command_len = strlen(commands->items[i].string);
 
-	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);
+		strbuf_addstr(buf, commands->items[i].string);
+		strbuf_addch(buf, '\n');
+
+		base_items[i].command = TODO_EXEC;
+		base_items[i].offset_in_buf = base_offset;
+		base_items[i].arg_offset = base_offset + strlen("exec ");
+		base_items[i].arg_len = command_len - strlen("exec ");
+
+		base_offset += command_len + 1;
 	}
 
 	/*
@@ -4473,38 +4475,62 @@ int sequencer_add_exec_commands(struct repository *r,
 	 * those chains if there are any.
 	 */
 	insert = -1;
-	for (i = 0; i < todo_list.nr; i++) {
-		enum todo_command command = todo_list.items[i].command;
-
-		if (insert >= 0) {
-			/* skip fixup/squash chains */
-			if (command == TODO_COMMENT)
-				continue;
-			else if (is_fixup(command)) {
-				insert = i + 1;
-				continue;
-			}
-			strbuf_insert(buf,
-				      todo_list.items[insert].offset_in_buf +
-				      offset, commands, commands_len);
-			offset += commands_len;
+	for (i = 0; i < todo_list->nr; i++) {
+		enum todo_command command = todo_list->items[i].command;
+		if (insert >= 0 && command != TODO_COMMENT && !is_fixup(command)) {
+			ALLOC_GROW(items, nr + commands->nr, alloc);
+			COPY_ARRAY(items + nr, base_items, commands->nr);
+			nr += commands->nr;
 			insert = -1;
 		}
 
-		if (command == TODO_PICK || command == TODO_MERGE)
+		ALLOC_GROW(items, nr + 1, alloc);
+		items[nr++] = todo_list->items[i];
+
+		if (command == TODO_PICK || command == TODO_MERGE || is_fixup(command))
 			insert = i + 1;
 	}
 
 	/* insert or append final <commands> */
-	if (insert >= 0 && insert < todo_list.nr)
-		strbuf_insert(buf, todo_list.items[insert].offset_in_buf +
-			      offset, commands, commands_len);
-	else if (insert >= 0 || !offset)
-		strbuf_add(buf, commands, commands_len);
+	if (insert >= 0 || nr == todo_list->nr) {
+		ALLOC_GROW(items, nr + commands->nr, alloc);
+		COPY_ARRAY(items + nr, base_items, commands->nr);
+		nr += commands->nr;
+	}
+
+	free(base_items);
+	FREE_AND_NULL(todo_list->items);
+	todo_list->items = items;
+	todo_list->nr = nr;
+	todo_list->alloc = alloc;
+}
 
-	i = write_message(buf->buf, buf->len, todo_file, 0);
+/*
+ * Add commands after pick and (series of) squash/fixup commands
+ * in the todo list.
+ */
+int sequencer_add_exec_commands(struct repository *r,
+				struct string_list *commands)
+{
+	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);
+	}
+
+	todo_list_add_exec_commands(&todo_list, commands);
+	res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1, 0);
 	todo_list_release(&todo_list);
-	return i;
+
+	if (res)
+		return error_errno(_("could not write '%s'."), todo_file);
+	return 0;
 }
 
 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
@@ -4735,7 +4761,7 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash)
 {
 	const char *shortonto, *todo_file = rebase_path_todo();
@@ -4754,8 +4780,8 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	if (autosquash && rearrange_squash(r))
 		return -1;
 
-	if (cmd && *cmd)
-		sequencer_add_exec_commands(r, cmd);
+	if (commands->nr)
+		sequencer_add_exec_commands(r, commands);
 
 	if (strbuf_read_file(buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
sequencer.h +3 -2
index 1de97f188d..e79f03e213 100644
@@ -146,12 +146,13 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 			  const char **argv,
 			  unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r, const char *command);
+int sequencer_add_exec_commands(struct repository *r,
+				struct string_list *commands);
 int transform_todo_file(struct repository *r, unsigned flags);
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
 int rearrange_squash(struct repository *r);
 
#128 lore raw

PATCH v6 8/16 sequencer: refactor rearrange_squash() to work on a todo_list

In reply to Alban Gruin

This refactors rearrange_squash() to work on a todo_list to avoid redundant reads and writes. The function is renamed todo_list_rearrange_squash().

The old version created a new buffer, which was directly written to the disk. This new version creates a new item list by just copying items from the old item list, without creating a new buffer. This eliminates the need to reparse the todo list, but this also means its buffer cannot be directly written to the disk.

As rebase -p still need to check the todo list from the disk, a new function is introduced, rearrange_squash_in_todo_file().

complete_action() still uses rearrange_squash_in_todo_file() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  2 +-
 sequencer.c                   | 92 ++++++++++++++++++-----------------
 sequencer.h                   |  2 +-
 3 files changed, 49 insertions(+), 47 deletions(-)
builtin/rebase--interactive.c +1 -1
index 53056ee713..4f0eae9239 100644
@@ -266,7 +266,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = check_todo_list_from_file(the_repository);
 		break;
 	case REARRANGE_SQUASH:
-		ret = rearrange_squash(the_repository);
+		ret = rearrange_squash_in_todo_file(the_repository);
 		break;
 	case ADD_EXEC:
 		ret = sequencer_add_exec_commands(the_repository, &commands);
sequencer.c +47 -45

156 lines not on this page · raw message

sequencer.h +1 -1
index e79f03e213..c7bb38d6df 100644
@@ -154,7 +154,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		    const char *shortrevisions, const char *onto_name,
 		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
-int rearrange_squash(struct repository *r);
+int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
 
Signature · 1 line
2.20.1
#129 lore raw

PATCH v6 9/16 sequencer: make sequencer_make_script() write its script to a strbuf

In reply to Alban Gruin

This makes sequencer_make_script() write its script to a strbuf (ie. the buffer of a todo_list) instead of a FILE. This reduce the amount of read/write made by rebase interactive.

---
 builtin/rebase--interactive.c | 13 ++++++-----
 sequencer.c                   | 41 +++++++++++++++--------------------
 sequencer.h                   |  5 ++---
 3 files changed, 28 insertions(+), 31 deletions(-)
builtin/rebase--interactive.c +8 -5
index 4f0eae9239..92026739c9 100644
@@ -71,7 +71,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list;
+	FILE *todo_list_file;
+	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
 		return -1;
@@ -93,8 +94,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list = fopen(rebase_path_todo(), "w");
-	if (!todo_list) {
+	todo_list_file = fopen(rebase_path_todo(), "w");
+	if (!todo_list_file) {
 		free(revisions);
 		free(shortrevisions);
 
@@ -105,10 +106,11 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
 
-	ret = sequencer_make_script(the_repository, todo_list,
+	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fclose(todo_list);
+	fputs(todo_list.buf.buf, todo_list_file);
+	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
@@ -121,6 +123,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 
 	free(revisions);
 	free(shortrevisions);
+	todo_list_release(&todo_list);
 	argv_array_clear(&make_script_args);
 
 	return ret;
sequencer.c +18 -23

101 lines not on this page · raw message

sequencer.h +2 -3
index c7bb38d6df..9b8edd7df6 100644
@@ -142,9 +142,8 @@ int sequencer_remove_state(struct replay_opts *opts);
 #define TODO_LIST_REBASE_COUSINS (1U << 4)
 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
 
-int sequencer_make_script(struct repository *r, FILE *out, int argc,
-			  const char **argv,
-			  unsigned flags);
+int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
+			  const char **argv, unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r,
 				struct string_list *commands);
Signature · 1 line
2.20.1
#130 lore raw

PATCH v6 10/16 sequencer: change complete_action() to use the refactored functions

In reply to Alban Gruin

complete_action() used functions that read the todo-list file, made some changes to it, and wrote it back to the disk.

The previous commits were dedicated to separate the part that deals with the file from the actual logic of these functions. Now that this is done, we can call directly the "logic" functions to avoid useless file access.

The parsing of the list has to be done by the caller. If the buffer of the todo list provided by the caller is empty, a `noop' command is directly added to the todo list, without touching the buffer.

---
 builtin/rebase--interactive.c | 20 +++------
 sequencer.c                   | 81 +++++++++++++++--------------------
 sequencer.h                   |  2 +-
 3 files changed, 42 insertions(+), 61 deletions(-)
builtin/rebase--interactive.c +6 -14
index 92026739c9..2dbf8fc08b 100644
@@ -71,7 +71,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list_file;
 	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
@@ -94,14 +93,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list_file = fopen(rebase_path_todo(), "w");
-	if (!todo_list_file) {
-		free(revisions);
-		free(shortrevisions);
-
-		return error_errno(_("could not open %s"), rebase_path_todo());
-	}
-
 	argv_array_pushl(&make_script_args, "", revisions, NULL);
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
@@ -109,16 +100,17 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fputs(todo_list.buf.buf, todo_list_file);
-	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
 	else {
 		discard_cache();
-		ret = complete_action(the_repository, opts, flags,
-				      shortrevisions, onto_name, onto,
-				      head_hash, commands, autosquash);
+		if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
+						&todo_list))
+			BUG("unusable todo list");
+
+		ret = complete_action(the_repository, opts, flags, shortrevisions, onto_name,
+				      onto, head_hash, commands, autosquash, &todo_list);
 	}
 
 	free(revisions);
sequencer.c +35 -46

135 lines not on this page · raw message

sequencer.h +1 -1
index 9b8edd7df6..0c30e43f0a 100644
@@ -152,7 +152,7 @@ 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);
+		    unsigned autosquash, struct todo_list *todo_list);
 int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
Signature · 1 line
2.20.1
#131 lore raw

Re: [PATCH v6 10/16] sequencer: change complete_action() to use the refactored functions

sequencer.c static int skip_unnecessary_picks(struct repository *r, struct object_id *output · line 4841

Quoted 9 lines · Alban Gruin
sequencer.c +1 -1
 	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
 		return error(_("could not skip unnecessary pick commands"));
 
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
-;
+
 	if (require_clean_work_tree(r, "rebase", "", 1, 1))
 		return -1;

This hunk was fishy (in my tree, there is no such line with ';' alone, as I believe that we've already fixed it) and made me spend some time to figure out why the patch does not apply, but once the cause was known it was trivial to fix.

I've looked at the difference since the previous version, but in essence, the only change I saw was that four instances of similar expressions are replaced with calls to a new todo_item_get_arg() helper and no other changes.

Thanks, will replace.

#132 lore raw

Re: [PATCH v6 10/16] sequencer: change complete_action() to use the refactored functions

Hi Junio,

Le 29/01/2019 à 21:14, Junio C Hamano a écrit :

Quoted 12 lines

sequencer.c static int skip_unnecessary_picks(struct repository *r, struct object_id *output · line 4841

Quoted 9 lines · Alban Gruin
sequencer.c +1 -1
 	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
 		return error(_("could not skip unnecessary pick commands"));
 
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
-;
+
 	if (require_clean_work_tree(r, "rebase", "", 1, 1))
 		return -1;
Quoted 5 lines

This hunk was fishy (in my tree, there is no such line with ';' alone, as I believe that we've already fixed it) and made me spend some time to figure out why the patch does not apply, but once the cause was known it was trivial to fix.

Indeed, this semicolon was removed by 29d51e214c ("sequencer.c: remove a stray semicolon", 2018-11-03). But this commit isn’t part of nd/the-index.

Quoted 7 lines

I've looked at the difference since the previous version, but in essence, the only change I saw was that four instances of similar expressions are replaced with calls to a new todo_item_get_arg() helper and no other changes.

Thanks, will replace.

Cheers,
Alban

#133 lore raw

Re: [PATCH v6 10/16] sequencer: change complete_action() to use the refactored functions

Quoted 2 lines · Alban Gruin

Indeed, this semicolon was removed by 29d51e214c ("sequencer.c: remove a stray semicolon", 2018-11-03). But this commit isn’t part of nd/the-index.

I thought you said it was based on nd/the-index, so I've been queuing the topic since earlier iterations on top of cde55548 which is where nd/the-index was merged to 'master'.

#134 lore raw

PATCH v6 11/16 sequencer: refactor skip_unnecessary_picks() to work on a todo_list

In reply to Alban Gruin

This refactors skip_unnecessary_picks() to work on a todo_list. As this function is only called by complete_action() (and thus is not used by rebase -p), the file-handling logic is completely dropped here.

Instead of truncating the todo list’s buffer, the items are moved to the beginning of the list, eliminating the need to reparse the list. This also means its buffer cannot be directly written to the disk.

rewrite_file() is then removed, as it is now unused.

---
 sequencer.c | 78 ++++++++++++-----------------------------------------
 1 file changed, 17 insertions(+), 61 deletions(-)
sequencer.c +17 -61
index 2a43ca685b..a817afffa9 100644
@@ -4661,52 +4661,22 @@ int check_todo_list_from_file(struct repository *r)
 	return res;
 }
 
-static int rewrite_file(const char *path, const char *buf, size_t len)
-{
-	int rc = 0;
-	int fd = open(path, O_WRONLY | O_TRUNC);
-	if (fd < 0)
-		return error_errno(_("could not open '%s' for writing"), path);
-	if (write_in_full(fd, buf, len) < 0)
-		rc = error_errno(_("could not write to '%s'"), path);
-	if (close(fd) && !rc)
-		rc = error_errno(_("could not close '%s'"), path);
-	return rc;
-}
-
 /* skip picking commits whose parents are unchanged */
-static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
+static int skip_unnecessary_picks(struct repository *r,
+				  struct todo_list *todo_list,
+				  struct object_id *output_oid)
 {
-	const char *todo_file = rebase_path_todo();
-	struct strbuf buf = STRBUF_INIT;
-	struct todo_list todo_list = TODO_LIST_INIT;
 	struct object_id *parent_oid;
-	int fd, i;
-
-	if (!read_oneliner(&buf, rebase_path_onto(), 0))
-		return error(_("could not read 'onto'"));
-	if (get_oid(buf.buf, output_oid)) {
-		strbuf_release(&buf);
-		return error(_("need a HEAD to fixup"));
-	}
-	strbuf_release(&buf);
-
-	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;
-	}
+	int i;
 
-	for (i = 0; i < todo_list.nr; i++) {
-		struct todo_item *item = todo_list.items + i;
+	for (i = 0; i < todo_list->nr; i++) {
+		struct todo_item *item = todo_list->items + i;
 
 		if (item->command >= TODO_NOOP)
 			continue;
 		if (item->command != TODO_PICK)
 			break;
 		if (parse_commit(item->commit)) {
-			todo_list_release(&todo_list);
 			return error(_("could not parse commit '%s'"),
 				oid_to_hex(&item->commit->object.oid));
 		}
@@ -4720,37 +4690,21 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 		oidcpy(output_oid, &item->commit->object.oid);
 	}
 	if (i > 0) {
-		int offset = get_item_line_offset(&todo_list, i);
 		const char *done_path = rebase_path_done();
 
-		fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
-		if (fd < 0) {
-			error_errno(_("could not open '%s' for writing"),
-				    done_path);
-			todo_list_release(&todo_list);
-			return -1;
-		}
-		if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
+		if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
 			error_errno(_("could not write to '%s'"), done_path);
-			todo_list_release(&todo_list);
-			close(fd);
 			return -1;
 		}
-		close(fd);
 
-		if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
-				 todo_list.buf.len - offset) < 0) {
-			todo_list_release(&todo_list);
-			return -1;
-		}
+		MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
+		todo_list->nr -= i;
+		todo_list->current = 0;
 
-		todo_list.current = i;
-		if (is_fixup(peek_command(&todo_list, 0)))
-			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
+		if (is_fixup(peek_command(todo_list, 0)))
+			record_in_rewritten(output_oid, peek_command(todo_list, 0));
 	}
 
-	todo_list_release(&todo_list);
-
 	return 0;
 }
 
@@ -4823,6 +4777,11 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return -1;
 	}
 
+	if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
+		todo_list_release(&new_todo);
+		return error(_("could not skip unnecessary pick commands"));
+	}
+
 	if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
 				    flags & ~(TODO_LIST_SHORTEN_IDS))) {
 		todo_list_release(&new_todo);
@@ -4831,9 +4790,6 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 
 	todo_list_release(&new_todo);
 
-	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
-		return error(_("could not skip unnecessary pick commands"));
-
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
 
Signature · 1 line
2.20.1
#135 lore raw

Re: [PATCH v6 11/16] sequencer: refactor skip_unnecessary_picks() to work on a todo_list

Hi Alban

Quoted 26 lines · Alban Gruin

This refactors skip_unnecessary_picks() to work on a todo_list. As this function is only called by complete_action() (and thus is not used by rebase -p), the file-handling logic is completely dropped here.

Instead of truncating the todo list’s buffer, the items are moved to the beginning of the list, eliminating the need to reparse the list. This also means its buffer cannot be directly written to the disk.

rewrite_file() is then removed, as it is now unused.

---
 sequencer.c | 78 ++++++++++++-----------------------------------------
 1 file changed, 17 insertions(+), 61 deletions(-)
sequencer.c +0 -3
index 2a43ca685b..a817afffa9 100644
@@ -4661,52 +4661,22 @@ int check_todo_list_from_file(struct repository *r)
 	return res;
 }
 
-static int rewrite_file(const char *path, const char *buf, size_t len)
-{
-	int rc = 0;

sequencer.c int check_todo_list_from_file(struct repository *r) · line 4676

Quoted 10 lines
sequencer.c +0 -10
-	int fd = open(path, O_WRONLY | O_TRUNC);
-	if (fd < 0)
-		return error_errno(_("could not open '%s' for writing"), path);
-	if (write_in_full(fd, buf, len) < 0)
-		rc = error_errno(_("could not write to '%s'"), path);
-	if (close(fd) && !rc)
-		rc = error_errno(_("could not close '%s'"), path);
-	return rc;
-}
-

It's great to see that going

sequencer.c int check_todo_list_from_file(struct repository *r) · line 4667

Quoted 5 lines
sequencer.c +3 -1
 /* skip picking commits whose parents are unchanged */
-static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
+static int skip_unnecessary_picks(struct repository *r,
+				  struct todo_list *todo_list,
+				  struct object_id *output_oid)

output_oid is a bit misleading now as we now feed the function the onto commit with that parameter. Perhaps we could rename it to base_oid or something like that (I've been working on getting rebase -i to start without forking rebase--interactive and as part of that re-factoring I've changed the caller of this function to take a struct commit* rather than a string I got tripped up by this)

Best Wishes

Phillip

Quoted 104 lines
sequencer.c +14 -47
 {
-	const char *todo_file = rebase_path_todo();
-	struct strbuf buf = STRBUF_INIT;
-	struct todo_list todo_list = TODO_LIST_INIT;
 	struct object_id *parent_oid;
-	int fd, i;
-
-	if (!read_oneliner(&buf, rebase_path_onto(), 0))
-		return error(_("could not read 'onto'"));
-	if (get_oid(buf.buf, output_oid)) {
-		strbuf_release(&buf);
-		return error(_("need a HEAD to fixup"));
-	}
-	strbuf_release(&buf);
-
-	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;
-	}
+	int i;
 
-	for (i = 0; i < todo_list.nr; i++) {
-		struct todo_item *item = todo_list.items + i;
+	for (i = 0; i < todo_list->nr; i++) {
+		struct todo_item *item = todo_list->items + i;
 
 		if (item->command >= TODO_NOOP)
 			continue;
 		if (item->command != TODO_PICK)
 			break;
 		if (parse_commit(item->commit)) {
-			todo_list_release(&todo_list);
 			return error(_("could not parse commit '%s'"),
 				oid_to_hex(&item->commit->object.oid));
 		}
@@ -4720,37 +4690,21 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 		oidcpy(output_oid, &item->commit->object.oid);
 	}
 	if (i > 0) {
-		int offset = get_item_line_offset(&todo_list, i);
 		const char *done_path = rebase_path_done();
 
-		fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
-		if (fd < 0) {
-			error_errno(_("could not open '%s' for writing"),
-				    done_path);
-			todo_list_release(&todo_list);
-			return -1;
-		}
-		if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
+		if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
 			error_errno(_("could not write to '%s'"), done_path);
-			todo_list_release(&todo_list);
-			close(fd);
 			return -1;
 		}
-		close(fd);
 
-		if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
-				 todo_list.buf.len - offset) < 0) {
-			todo_list_release(&todo_list);
-			return -1;
-		}
+		MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
+		todo_list->nr -= i;
+		todo_list->current = 0;
 
-		todo_list.current = i;
-		if (is_fixup(peek_command(&todo_list, 0)))
-			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
+		if (is_fixup(peek_command(todo_list, 0)))
+			record_in_rewritten(output_oid, peek_command(todo_list, 0));
 	}
 
-	todo_list_release(&todo_list);
-
 	return 0;
 }
 
@@ -4823,6 +4777,11 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return -1;
 	}
 
+	if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
+		todo_list_release(&new_todo);
+		return error(_("could not skip unnecessary pick commands"));
+	}
+
 	if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
 				    flags & ~(TODO_LIST_SHORTEN_IDS))) {
 		todo_list_release(&new_todo);
@@ -4831,9 +4790,6 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 
 	todo_list_release(&new_todo);
 
-	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
-		return error(_("could not skip unnecessary pick commands"));
-
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
 
#136 lore raw

PATCH v6 12/16 rebase-interactive: use todo_list_write_to_file() in edit_todo_list()

In reply to Alban Gruin

Just like complete_action(), edit_todo_list() used a function (transform_todo_file()) that read the todo list from the disk and wrote it back, resulting in useless disk accesses.

This changes edit_todo_list() to call directly todo_list_write_to_file() instead.

---
 rebase-interactive.c | 38 ++++++++++++++++----------------------
 sequencer.c          |  4 ++--
 sequencer.h          |  3 ---
 3 files changed, 18 insertions(+), 27 deletions(-)
rebase-interactive.c +16 -22
index dfa6dd530f..d396ecc599 100644
@@ -79,39 +79,33 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 
 int edit_todo_list(struct repository *r, unsigned flags)
 {
-	struct strbuf buf = STRBUF_INIT;
 	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT;
+	int res = 0;
 
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
+	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
 
-	strbuf_stripspace(&buf, 1);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_stripspace(&todo_list.buf, 1);
+	todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+	if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
-
-	transform_todo_file(r, flags | TODO_LIST_SHORTEN_IDS);
-
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
-		return error_errno(_("could not read '%s'."), todo_file);
-
-	append_todo_help(1, 0, &buf);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_reset(&todo_list.buf);
+	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
+	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
+		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+					      flags & ~(TODO_LIST_SHORTEN_IDS));
 
-	if (launch_sequence_editor(todo_file, NULL, NULL))
-		return -1;
-
-	transform_todo_file(r, flags & ~(TODO_LIST_SHORTEN_IDS));
-
-	return 0;
+	todo_list_release(&todo_list);
+	return res;
 }
 
 define_commit_slab(commit_seen, unsigned char);
sequencer.c +2 -2
index a817afffa9..d8d045067c 100644
@@ -383,8 +383,8 @@ static void print_advice(struct repository *r, int show_hint,
 	}
 }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol)
+static int write_message(const void *buf, size_t len, const char *filename,
+			 int append_eol)
 {
 	struct lock_file msg_file = LOCK_INIT;
 
sequencer.h +0 -3
index 0c30e43f0a..c5bee8124c 100644
@@ -64,9 +64,6 @@ struct replay_opts {
 };
 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol);
-
 /*
  * Note that ordering matters in this enum. Not only must it match the mapping
  * of todo_command_info (in sequencer.c), it is also divided into several
Signature · 1 line
2.20.1
#137 lore raw

PATCH v6 13/16 rebase-interactive: append_todo_help() changes

In reply to Alban Gruin

This moves the writing of the comment "Rebase $shortrevisions onto $shortonto ($command_count commands)" from todo_list_write_to_file() to append_todo_help().

shortrevisions, shortonto, and command_count are passed as parameters to append_todo_help().

During the initial edit of the todo list, shortrevisions and shortonto are not NULL. Therefore, if shortrevisions or shortonto is NULL, then edit_todo would be true, otherwise it would be false. Thus, edit_todo is removed from the parameters of append_todo_help().

---
 rebase-interactive.c | 12 +++++++++++-
 rebase-interactive.h |  3 ++-
 sequencer.c          | 17 ++++-------------
 3 files changed, 17 insertions(+), 15 deletions(-)
rebase-interactive.c +11 -1
index d396ecc599..807f8370db 100644
@@ -28,7 +28,8 @@ static enum missing_commit_check_level get_missing_commit_check_level(void)
 	return MISSING_COMMIT_CHECK_IGNORE;
 }
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf)
 {
 	const char *msg = _("\nCommands:\n"
@@ -48,6 +49,15 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 ".       specified). Use -c <commit> to reword the commit message.\n"
 "\n"
 "These lines can be re-ordered; they are executed from top to bottom.\n");
+	unsigned edit_todo = !(shortrevisions && shortonto);
+
+	if (!edit_todo) {
+		strbuf_addch(buf, '\n');
+		strbuf_commented_addf(buf, Q_("Rebase %s onto %s (%d command)",
+					      "Rebase %s onto %s (%d commands)",
+					      command_count),
+				      shortrevisions, shortonto, command_count);
+	}
 
 	strbuf_add_commented_lines(buf, msg, strlen(msg));
 
rebase-interactive.h +2 -1
index 187b5032d6..0e5925e3aa 100644
@@ -5,7 +5,8 @@ struct strbuf;
 struct repository;
 struct todo_list;
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
 int edit_todo_list(struct repository *r, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
sequencer.c +4 -13
index d8d045067c..92de982bc4 100644
@@ -4580,22 +4580,13 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 			    const char *file, const char *shortrevisions,
 			    const char *shortonto, int num, unsigned flags)
 {
-	int edit_todo = !(shortrevisions && shortonto), res;
+	int res;
 	struct strbuf buf = STRBUF_INIT;
 
 	todo_list_to_strbuf(r, todo_list, &buf, num, flags);
-
-	if (flags & TODO_LIST_APPEND_TODO_HELP) {
-		int command_count = count_commands(todo_list);
-		if (!edit_todo) {
-			strbuf_addch(&buf, '\n');
-			strbuf_commented_addf(&buf, Q_("Rebase %s onto %s (%d command)",
-						       "Rebase %s onto %s (%d commands)",
-						       command_count),
-					      shortrevisions, shortonto, command_count);
-		}
-		append_todo_help(edit_todo, flags & TODO_LIST_KEEP_EMPTY, &buf);
-	}
+	if (flags & TODO_LIST_APPEND_TODO_HELP)
+		append_todo_help(flags & TODO_LIST_KEEP_EMPTY, count_commands(todo_list),
+				 shortrevisions, shortonto, &buf);
 
 	res = write_message(buf.buf, buf.len, file, 0);
 	strbuf_release(&buf);
Signature · 1 line
2.20.1
#138 lore raw

PATCH v6 14/16 rebase-interactive: rewrite edit_todo_list() to handle the initial edit

In reply to Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
 builtin/rebase--interactive.c | 24 +++++++++++++++++-
 rebase-interactive.c          | 48 ++++++++++++++++++-----------------
 rebase-interactive.h          |  4 ++-
 sequencer.c                   |  3 +--
 sequencer.h                   |  1 +
 5 files changed, 53 insertions(+), 27 deletions(-)
builtin/rebase--interactive.c +23 -1
index 2dbf8fc08b..645ac587f7 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int edit_todo_file(unsigned flags)
+{
+	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT,
+		new_todo = TODO_LIST_INIT;
+
+	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
+		return error_errno(_("could not read '%s'."), todo_file);
+
+	strbuf_stripspace(&todo_list.buf, 1);
+	if (!edit_todo_list(the_repository, &todo_list,
+			    &new_todo, NULL, NULL, flags) &&
+	    todo_list_write_to_file(the_repository, &new_todo, todo_file, NULL, NULL,
+				    -1, flags & ~(TODO_LIST_SHORTEN_IDS)) < 0)
+		return error_errno(_("could not write '%s'"), todo_file);
+
+	todo_list_release(&todo_list);
+	todo_list_release(&new_todo);
+
+	return 0;
+}
+
 static int get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -242,7 +264,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		break;
 	}
 	case EDIT_TODO:
-		ret = edit_todo_list(the_repository, flags);
+		ret = edit_todo_file(flags);
 		break;
 	case SHOW_CURRENT_PATCH: {
 		struct child_process cmd = CHILD_PROCESS_INIT;
rebase-interactive.c +25 -23

60 lines not on this page · raw message

rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
 void append_todo_help(unsigned keep_empty, int command_count,
 		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +1 -2
index 92de982bc4..8f47f0cf39 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  * file and written to the tail of 'done'.
  */
 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-		     "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
 
 /*
  * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index c5bee8124c..68acab980b 100644
@@ -10,6 +10,7 @@ struct repository;
 const char *git_path_commit_editmsg(void);
 const char *git_path_seq_dir(void);
 const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
 
 #define APPEND_SIGNOFF_DEDUP (1u << 0)
 
Signature · 1 line
2.20.1
#139 lore raw

Re: [PATCH v6 14/16] rebase-interactive: rewrite edit_todo_list() to handle the initial edit

Hi Alban

This looks good apart from some missing error handling.

Quoted 30 lines · Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
  builtin/rebase--interactive.c | 24 +++++++++++++++++-
  rebase-interactive.c          | 48 ++++++++++++++++++-----------------
  rebase-interactive.h          |  4 ++-
  sequencer.c                   |  3 +--
  sequencer.h                   |  1 +
  5 files changed, 53 insertions(+), 27 deletions(-)
builtin/rebase--interactive.c +5 -0
index 2dbf8fc08b..645ac587f7 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
  static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
  static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int edit_todo_file(unsigned flags)
+{
+	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT,
+		new_todo = TODO_LIST_INIT;

builtin/rebase--interactive.c static GIT_PATH_FUNC(path_state_dir, "rebase-merge/") · line 30

Quoted 10 lines
builtin/rebase--interactive.c +10 -0
+
+	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
+		return error_errno(_("could not read '%s'."), todo_file);
+
+	strbuf_stripspace(&todo_list.buf, 1);
+	if (!edit_todo_list(the_repository, &todo_list,
+			    &new_todo, NULL, NULL, flags) &&
+	    todo_list_write_to_file(the_repository, &new_todo, todo_file, NULL, NULL,
+				    -1, flags & ~(TODO_LIST_SHORTEN_IDS)) < 0)
+		return error_errno(_("could not write '%s'"), todo_file);

If edit_todo_list() fails then the function returns 0. I think you need to do

if (edit_todo_list() || todo_list_write_file())
return error...

todo_list_write_file() forwards the return value of write_message() which is 0/-1 so there is no need for the '< 0'

Quoted 40 lines
builtin/rebase--interactive.c +8 -1
+
+	todo_list_release(&todo_list);
+	todo_list_release(&new_todo);
+
+	return 0;
+}
+
  static int get_revision_ranges(const char *upstream, const char *onto,
  			       const char **head_hash,
  			       char **revisions, char **shortrevisions)
@@ -242,7 +264,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
  		break;
  	}
  	case EDIT_TODO:
-		ret = edit_todo_list(the_repository, flags);
+		ret = edit_todo_file(flags);
  		break;
  	case SHOW_CURRENT_PATCH: {
  		struct child_process cmd = CHILD_PROCESS_INIT;
rebase-interactive.c +3 -8
index 807f8370db..3301efbe52 100644
@@ -87,35 +87,37 @@ void append_todo_help(unsigned keep_empty, int command_count,
  	}
  }
 
-int edit_todo_list(struct repository *r, unsigned flags)
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags)
  {
  	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);
-
-	strbuf_stripspace(&todo_list.buf, 1);

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count, · line 99

Quoted 10 lines
rebase-interactive.c +5 -5
-	todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
-	if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
-				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
-		todo_list_release(&todo_list);
-		return -1;
+	unsigned initial = shortrevisions && shortonto;
+
+	if (initial) {
+		todo_list_write_to_file(r, todo_list, todo_file, shortrevisions, shortonto,
+					-1, flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP);

This has lost the error handling when we cannot write the file

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count, · line 107

Quoted 8 lines
rebase-interactive.c +8 -0
+
+		if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
+			return error(_("could not copy '%s' to '%s'."), todo_file,
+				     rebase_path_todo_backup());
+	} else {
+		todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
+		todo_list_write_to_file(r, todo_list, todo_file, NULL, NULL, -1,
+					flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP);

error handling again

Quoted 11 lines
rebase-interactive.c +2 -6
  	}
 
-	strbuf_reset(&todo_list.buf);
-	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
-		todo_list_release(&todo_list);
-		return -1;
-	}
+	if (launch_sequence_editor(todo_file, &new_todo->buf, NULL))
+		return -2;
 
-	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count, · line 118

Quoted 10 lines
rebase-interactive.c +5 -4
-		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
-					      flags & ~(TODO_LIST_SHORTEN_IDS));
+	strbuf_stripspace(&new_todo->buf, 1);
+	if (initial && new_todo->buf.len == 0)
+		return -3;
 
-	todo_list_release(&todo_list);
-	return res;
+	if (!initial)
+		todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);

error handling. Also why don't we try parse the file for the initial edit - is it done somewhere else?

Best Wishes

Phillip

Quoted 47 lines
rebase-interactive.c +2 -0
+
+	return 0;
  }
 
  define_commit_slab(commit_seen, unsigned char);
rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
  void append_todo_help(unsigned keep_empty, int command_count,
  		      const char *shortrevisions, const char *shortonto,
  		      struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags);
  int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
  #endif
sequencer.c +1 -2
index 92de982bc4..8f47f0cf39 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
   * file and written to the tail of 'done'.
   */
  GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-		     "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
 
  /*
   * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index c5bee8124c..68acab980b 100644
@@ -10,6 +10,7 @@ struct repository;
  const char *git_path_commit_editmsg(void);
  const char *git_path_seq_dir(void);
  const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
 
  #define APPEND_SIGNOFF_DEDUP (1u << 0)
 
#140 lore raw

Re: [PATCH v6 14/16] rebase-interactive: rewrite edit_todo_list() to handle the initial edit

Hi Phillip,

Le 01/02/2019 à 12:03, Phillip Wood a écrit :

Quoted 21 lines
Quoted 12 lines

      }
  -    strbuf_reset(&todo_list.buf);
-    if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) { -        todo_list_release(&todo_list);
-        return -1;
-    }
+    if (launch_sequence_editor(todo_file, &new_todo->buf, NULL)) +        return -2;
  -    if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
-        res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,

Quoted 8 lines

-                          flags & ~(TODO_LIST_SHORTEN_IDS)); +    strbuf_stripspace(&new_todo->buf, 1);
+    if (initial && new_todo->buf.len == 0)
+        return -3;
  -    todo_list_release(&todo_list);
-    return res;
+    if (!initial)
+        todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);

Quoted 3 lines

error handling. Also why don't we try parse the file for the initial edit - is it done somewhere else?

Yes, it’s done in complete_action().

-- Alban

Quoted 49 lines

Best Wishes

Phillip

Quoted 44 lines

+
+    return 0;
  }
    define_commit_slab(commit_seen, unsigned char);

rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
   void append_todo_help(unsigned keep_empty, int command_count,
                 const char *shortrevisions, const char *shortonto,
                 struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+           struct todo_list *new_todo, const char *shortrevisions,
+           const char *shortonto, unsigned flags);

  int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
    #endif

sequencer.c +1 -2
index 92de982bc4..8f47f0cf39 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
    * file and written to the tail of 'done'.
    */
   GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-             "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup,
 "rebase-merge/git-rebase-todo.backup")
     /*
    * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index c5bee8124c..68acab980b 100644
@@ -10,6 +10,7 @@ struct repository;
   const char *git_path_commit_editmsg(void);
   const char *git_path_seq_dir(void);
   const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
     #define APPEND_SIGNOFF_DEDUP (1u << 0)

#141 lore raw

Re: [PATCH v6 14/16] rebase-interactive: rewrite edit_todo_list() to handle the initial edit

In reply to Phillip Wood

Hi Phillip,

I’ve just reread this message and have a couple of additionnal comments.

Le 01/02/2019 à 12:03, Phillip Wood a écrit :

Quoted 50 lines

Hi Alban

This looks good apart from some missing error handling.

Quoted 31 lines · Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
  builtin/rebase--interactive.c | 24 +++++++++++++++++- rebase-interactive.c          | 48 ++++++++++++++++++----------------- rebase-interactive.h          |  4 ++-
  sequencer.c                   |  3 +--
  sequencer.h                   |  1 +

  5 files changed, 53 insertions(+), 27 deletions(-)
builtin/rebase--interactive.c +5 -0
index 2dbf8fc08b..645ac587f7 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
   static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
   static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
   +static int edit_todo_file(unsigned flags)
+{
+    const char *todo_file = rebase_path_todo();
+    struct todo_list todo_list = TODO_LIST_INIT,
+        new_todo = TODO_LIST_INIT;
+

builtin/rebase--interactive.c static GIT_PATH_FUNC(path_state_dir, "rebase-merge/") · line 30

Quoted 10 lines
builtin/rebase--interactive.c +9 -0
+    if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
+        return error_errno(_("could not read '%s'."), todo_file);
+
+    strbuf_stripspace(&todo_list.buf, 1);
+    if (!edit_todo_list(the_repository, &todo_list,
+                &new_todo, NULL, NULL, flags) &&
+        todo_list_write_to_file(the_repository, &new_todo, todo_file,
 NULL, NULL,
+                    -1, flags & ~(TODO_LIST_SHORTEN_IDS)) < 0)
+        return error_errno(_("could not write '%s'"), todo_file);

If edit_todo_list() fails then the function returns 0. I think you need to do

Quoted 6 lines

if (edit_todo_list() || todo_list_write_file())
    return error...

todo_list_write_file() forwards the return value of write_message() which is 0/-1 so there is no need for the '< 0'

With your proposed condition, if edit_todo_list() fails, the error "could not write '%s'" will be shown, if I’m not mistaken. But in my version, if edit_todo_list() fails, the return value is 0. Perhaps I should write something like this instead:

    int res = 0;
    …
    res = edit_todo_list();
    if (!res && todo_list_write_to_file())
        return error;
    …
    return res;
Quoted 68 lines
Quoted 45 lines
builtin/rebase--interactive.c +7 -0
+
+    todo_list_release(&todo_list);
+    todo_list_release(&new_todo);
+
+    return 0;
+}
+
   static int get_revision_ranges(const char *upstream, const char *onto,
                      const char **head_hash,

                     char **revisions, char **shortrevisions)

builtin/rebase--interactive.c +0 -0
@@ -242,7 +264,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
           break;
       }

      case EDIT_TODO:
-        ret = edit_todo_list(the_repository, flags); +        ret = edit_todo_file(flags);
          break;
      case SHOW_CURRENT_PATCH: {
          struct child_process cmd = CHILD_PROCESS_INIT;

rebase-interactive.c +3 -11
index 807f8370db..3301efbe52 100644
@@ -87,35 +87,37 @@ void append_todo_help(unsigned keep_empty, int
 command_count,
       }
   }
   -int edit_todo_list(struct repository *r, unsigned flags)
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+           struct todo_list *new_todo, const char *shortrevisions,
+           const char *shortonto, unsigned flags)
   {
       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);
-
-    strbuf_stripspace(&todo_list.buf, 1);
-    todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
-    if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL,
-1,
-                    flags | TODO_LIST_SHORTEN_IDS |

rebase-interactive.c void append_todo_help(unsigned keep_empty, int · line 103

Quoted 10 lines
rebase-interactive.c +5 -2
 TODO_LIST_APPEND_TODO_HELP)) {
-        todo_list_release(&todo_list);
-        return -1;
+    unsigned initial = shortrevisions && shortonto;
+
+    if (initial) {
+        todo_list_write_to_file(r, todo_list, todo_file,
 shortrevisions, shortonto,
+                    -1, flags | TODO_LIST_SHORTEN_IDS |
 TODO_LIST_APPEND_TODO_HELP);

This has lost the error handling when we cannot write the file

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count,

Quoted 9 lines
rebase-interactive.c +8 -0
+
+        if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
+            return error(_("could not copy '%s' to '%s'."), todo_file,
+                     rebase_path_todo_backup());
+    } else {
+        todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
+        todo_list_write_to_file(r, todo_list, todo_file, NULL, NULL, -1,
+                    flags | TODO_LIST_SHORTEN_IDS |
 TODO_LIST_APPEND_TODO_HELP);
Quoted 2 lines

error handling again

I agree for todo_list_write_to_file(), but todo_list_parse_insn_buffer() already shows an error, and here it should not return -- we want to edit the todo list to remove an error, but git would fail because the todo list has an error.

-- Alban

#142 lore raw

Re: [PATCH v6 14/16] rebase-interactive: rewrite edit_todo_list() to handle the initial edit

Hi Alban

Quoted 58 lines · Alban Gruin

Hi Phillip,

I’ve just reread this message and have a couple of additionnal comments.

Le 01/02/2019 à 12:03, Phillip Wood a écrit :

Quoted 53 lines

Hi Alban

This looks good apart from some missing error handling.

Quoted 31 lines · Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
  builtin/rebase--interactive.c | 24 +++++++++++++++++- rebase-interactive.c          | 48 ++++++++++++++++++----------------- rebase-interactive.h          |  4 ++-
  sequencer.c                   |  3 +--
  sequencer.h                   |  1 +

  5 files changed, 53 insertions(+), 27 deletions(-)
builtin/rebase--interactive.c +5 -0
index 2dbf8fc08b..645ac587f7 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
   static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
   static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
   +static int edit_todo_file(unsigned flags)
+{
+    const char *todo_file = rebase_path_todo();
+    struct todo_list todo_list = TODO_LIST_INIT,
+        new_todo = TODO_LIST_INIT;
+

builtin/rebase--interactive.c static GIT_PATH_FUNC(path_state_dir, "rebase-merge/") · line 30

Quoted 10 lines
builtin/rebase--interactive.c +9 -0
+    if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
+        return error_errno(_("could not read '%s'."), todo_file);
+
+    strbuf_stripspace(&todo_list.buf, 1);
+    if (!edit_todo_list(the_repository, &todo_list,
+                &new_todo, NULL, NULL, flags) &&
+        todo_list_write_to_file(the_repository, &new_todo, todo_file,
 NULL, NULL,
+                    -1, flags & ~(TODO_LIST_SHORTEN_IDS)) < 0)
+        return error_errno(_("could not write '%s'"), todo_file);

If edit_todo_list() fails then the function returns 0. I think you need to do

if (edit_todo_list() || todo_list_write_file())
    return error...

Quoted 6 lines
Quoted 3 lines

todo_list_write_file() forwards the return value of write_message() which is 0/-1 so there is no need for the '< 0'

With your proposed condition, if edit_todo_list() fails, the error "could not write '%s'" will be shown, if I’m not mistaken.

Yes, you're right but as edit_todo_list() will have already printed an error I decided it didn't matter too much, but it would be better to avoid it as you suggest.

Quoted 9 lines

But in my
version, if edit_todo_list() fails, the return value is 0. Perhaps I should write something like this instead:

    int res = 0;
    …
    res = edit_todo_list();
    if (!res && todo_list_write_to_file())
        return error;

If you did

	ret = error...;

instead then we always free the todo lists before exiting the function.

Quoted 70 lines
    …
    return res;
Quoted 68 lines
Quoted 45 lines
builtin/rebase--interactive.c +7 -0
+
+    todo_list_release(&todo_list);
+    todo_list_release(&new_todo);
+
+    return 0;
+}
+
   static int get_revision_ranges(const char *upstream, const char *onto,
                      const char **head_hash,

                     char **revisions, char **shortrevisions)

builtin/rebase--interactive.c +0 -0
@@ -242,7 +264,7 @@ int cmd_rebase__interactive(int argc, const char
 **argv, const char *prefix)
           break;
       }

      case EDIT_TODO:
-        ret = edit_todo_list(the_repository, flags); +        ret = edit_todo_file(flags);
          break;
      case SHOW_CURRENT_PATCH: {
          struct child_process cmd = CHILD_PROCESS_INIT;

rebase-interactive.c +3 -11
index 807f8370db..3301efbe52 100644
@@ -87,35 +87,37 @@ void append_todo_help(unsigned keep_empty, int
 command_count,
       }
   }
   -int edit_todo_list(struct repository *r, unsigned flags)
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+           struct todo_list *new_todo, const char *shortrevisions,
+           const char *shortonto, unsigned flags)
   {
       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);
-
-    strbuf_stripspace(&todo_list.buf, 1);
-    todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
-    if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL,
-1,
-                    flags | TODO_LIST_SHORTEN_IDS |

rebase-interactive.c void append_todo_help(unsigned keep_empty, int · line 103

Quoted 10 lines
rebase-interactive.c +5 -2
 TODO_LIST_APPEND_TODO_HELP)) {
-        todo_list_release(&todo_list);
-        return -1;
+    unsigned initial = shortrevisions && shortonto;
+
+    if (initial) {
+        todo_list_write_to_file(r, todo_list, todo_file,
 shortrevisions, shortonto,
+                    -1, flags | TODO_LIST_SHORTEN_IDS |
 TODO_LIST_APPEND_TODO_HELP);

This has lost the error handling when we cannot write the file

Quoted 9 lines
rebase-interactive.c +8 -0
+
+        if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
+            return error(_("could not copy '%s' to '%s'."), todo_file,
+                     rebase_path_todo_backup());
+    } else {
+        todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
+        todo_list_write_to_file(r, todo_list, todo_file, NULL, NULL, -1,
+                    flags | TODO_LIST_SHORTEN_IDS |
 TODO_LIST_APPEND_TODO_HELP);
Quoted 7 lines
Quoted 2 lines

error handling again

I agree for todo_list_write_to_file(), but todo_list_parse_insn_buffer() already shows an error, and here it should not return -- we want to edit the todo list to remove an error, but git would fail because the todo list has an error.

Ah yes, that is what the original was doing

Best Wishes

Phillip

Quoted 3 lines

-- Alban

#143 lore raw

PATCH v6 15/16 sequencer: use edit_todo_list() in complete_action()

In reply to Alban Gruin

This changes complete_action() to use edit_todo_list(), now that it can handle the initial edit of the todo list.

---
 sequencer.c | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)
sequencer.c +7 -14
index 8f47f0cf39..21b04e0642 100644
@@ -4709,6 +4709,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	struct todo_list new_todo = TODO_LIST_INIT;
 	struct strbuf *buf = &todo_list->buf;
 	struct object_id oid;
+	int res;
 
 	get_oid(onto, &oid);
 	shortonto = find_unique_abbrev(&oid, DEFAULT_ABBREV);
@@ -4733,24 +4734,16 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return error(_("nothing to do"));
 	}
 
-	if (todo_list_write_to_file(r, todo_list, todo_file,
-				    shortrevisions, shortonto, -1,
-				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
-		return error_errno(_("could not write '%s'"), todo_file);
-
-	if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
-		return error(_("could not copy '%s' to '%s'."), todo_file,
-			     rebase_path_todo_backup());
-
-	if (launch_sequence_editor(todo_file, &new_todo.buf, NULL)) {
+	res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
+			     shortonto, flags);
+	if (res == -1)
+		return -1;
+	else if (res == -2) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 
 		return -1;
-	}
-
-	strbuf_stripspace(&new_todo.buf, 1);
-	if (new_todo.buf.len == 0) {
+	} else if (res == -3) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 		todo_list_release(&new_todo);
Signature · 1 line
2.20.1
#144 lore raw

PATCH v6 16/16 rebase--interactive: move transform_todo_file() to rebase--interactive.c

In reply to Alban Gruin

As transform_todo_file() is only needed inside of rebase--interactive.c, it is moved there from sequencer.c.

---
 builtin/rebase--interactive.c | 26 +++++++++++++++++++++++++-
 sequencer.c                   | 23 -----------------------
 sequencer.h                   |  1 -
 3 files changed, 25 insertions(+), 25 deletions(-)
builtin/rebase--interactive.c +25 -1
index 645ac587f7..7f1e88a087 100644
@@ -35,6 +35,30 @@ static int edit_todo_file(unsigned flags)
 	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 get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -277,7 +301,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	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);
sequencer.c +0 -23
index 21b04e0642..5239700efc 100644
@@ -4593,29 +4593,6 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 	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"
sequencer.h +0 -1
index 68acab980b..11afd47aa9 100644
@@ -145,7 +145,6 @@ int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 
 int sequencer_add_exec_commands(struct repository *r,
 				struct string_list *commands);
-int transform_todo_file(struct repository *r, unsigned flags);
 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,
Signature · 1 line
2.20.1
#145 lore raw

Re: [PATCH v6 16/16] rebase--interactive: move transform_todo_file() to rebase--interactive.c

Hi Alban

Quoted 2 lines · Alban Gruin

As transform_todo_file() is only needed inside of rebase--interactive.c, it is moved there from sequencer.c.

I think I'd prefer to minimize the code under builtin and move this to rebase-interactive.c when it is modified earlier in the series. (I'd be quite happy if all the files in builtin just consisted of some option parsing followed by a call to run_git_foo() which resides in libgit)

Also I wonder if we should be moving more functions (e.g. todo_list_write_file() and possibly add_exec_commands(), rearrange_squash() and the script generation) from sequencer.c to rebase-interactive.c when they're rewritten (possibly in a separate commit for ease of review) but I haven't looked if this is practical or if there are some dependencies that make that tricky. Unless there are some simple cases it should probably be a separate series.

Thanks for working on this series, it's great to see the todo list handling becoming more efficient.

Best Wishes

Phillip

Quoted 99 lines
---
  builtin/rebase--interactive.c | 26 +++++++++++++++++++++++++-
  sequencer.c                   | 23 -----------------------
  sequencer.h                   |  1 -
  3 files changed, 25 insertions(+), 25 deletions(-)
builtin/rebase--interactive.c +25 -1
index 645ac587f7..7f1e88a087 100644
@@ -35,6 +35,30 @@ static int edit_todo_file(unsigned flags)
  	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 get_revision_ranges(const char *upstream, const char *onto,
  			       const char **head_hash,
  			       char **revisions, char **shortrevisions)
@@ -277,7 +301,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
  	}
  	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);
sequencer.c +0 -23
index 21b04e0642..5239700efc 100644
@@ -4593,29 +4593,6 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
  	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"
sequencer.h +0 -1
index 68acab980b..11afd47aa9 100644
@@ -145,7 +145,6 @@ int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 
  int sequencer_add_exec_commands(struct repository *r,
  				struct string_list *commands);
-int transform_todo_file(struct repository *r, unsigned flags);
  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,
#146 lore raw

Re: [PATCH v6 16/16] rebase--interactive: move transform_todo_file() to rebase--interactive.c

Hi Phillip,

Le 01/02/2019 à 12:15, Phillip Wood a écrit :

Quoted 11 lines

Hi Alban

Quoted 2 lines · Alban Gruin

As transform_todo_file() is only needed inside of rebase--interactive.c, it is moved there from sequencer.c.

I think I'd prefer to minimize the code under builtin and move this to rebase-interactive.c when it is modified earlier in the series. (I'd be quite happy if all the files in builtin just consisted of some option parsing followed by a call to run_git_foo() which resides in libgit)

I do agree, but transform_todo_file() is only used by rebase -p. Once it is deprecated, it’s much easier to see this function is no longer used if it’s marked as static thanks to -Werror=unused-function.

Now that I think about it, check_todo_list_from_file(), rearrange_squash_in_todo_list(), and sequencer_add_exec_commands() are only used by rebase -p, but I left them in sequencer.c.

Quoted 8 lines

Also I wonder if we should be moving more functions (e.g. todo_list_write_file() and possibly add_exec_commands(), rearrange_squash() and the script generation) from sequencer.c to rebase-interactive.c when they're rewritten (possibly in a separate commit for ease of review) but I haven't looked if this is practical or if there are some dependencies that make that tricky. Unless there are some simple cases it should probably be a separate series.

It might be doable, but I think it’s a bit more difficult with sequencer_make_script() (and especially sequencer_make_script_with_merges()). I will explore this after this series.

Quoted 3 lines

Thanks for working on this series, it's great to see the todo list handling becoming more efficient.

You’re welcome ;-)

-- Alban

Quoted 4 lines

Best Wishes

Phillip

#147 lore raw

v7 cover sequencer: refactor functions working on a todo_list

In reply to Alban Gruin

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 v6:

- The series has been rebased onto cde555480b (this affects the patch 10/16).

- [07/16] rebase--interactive does no longer check if the last command is empty before decrementing the size of the command list, and frees the list before exiting.

- [07/16] `insert' (in todo_list_add_exec_commands()) is treated as a flag instead of an integer.

- [07/16] Styling change (++i -> i++).

- [07/16] `exec' commands are inserted before comments, not after.

- [11/16] Renaming output_oid' to base_oid'.

- [14/16] Better error handling in edit_todo_list() and edit_todo_file().

- [16/16] Move sequencer_add_exec_commands() and rearrange_squash_in_todo_file() to rebase--interactive.c.

The tip of this series is tagged as "refactor-todo-list-v7" in
https://github.com/agrn/git.

The range diff is included below.

Alban Gruin (16):
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
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 several functions to rebase--interactive.c

 builtin/rebase--interactive.c | 141 ++++++--
 rebase-interactive.c          | 141 ++++++--
 rebase-interactive.h          |   9 +-
 sequencer.c                   | 650 ++++++++++++----------------------
 sequencer.h                   |  81 ++++-
 5 files changed, 539 insertions(+), 483 deletions(-)

Range-diff against v6:

 1:  f5d6bb72fa =  1:  0bc5f714e5 sequencer: changes in parse_insn_buffer()
 2:  68dcdd233b =  2:  34d149ff25 sequencer: make the todo_list structure public
 3:  74152c4d60 =  3:  8200f7a6be sequencer: remove the 'arg' field from todo_item
 4:  aff98ea435 =  4:  ce8ca23ee0 sequencer: refactor transform_todos() to work on a todo_list
 5:  e4c85dd743 =  5:  67ebea475e sequencer: introduce todo_list_write_to_file()
 6:  5b1735671b =  6:  370c153ebe sequencer: refactor check_todo_list() to work on a todo_list
 7:  f0734897af !  7:  66e7b65509 sequencer: refactor sequencer_add_exec_commands() to work on a todo_list
    @@ -60,8 +60,7 @@
      
     +	if (cmd && *cmd) {
     +		string_list_split(&commands, cmd, '\n', -1);
    -+		if (strlen(commands.items[commands.nr - 1].string) == 0)
    -+			--commands.nr;
    ++		--commands.nr;
     +	}
     +
      	switch (command) {
    @@ -85,18 +84,19 @@
      		break;
      	default:
      		BUG("invalid command '%d'", command);
    + 	}
    + 
    ++	string_list_clear(&commands, 1);
    + 	return !!ret;
    + }
     
      diff --git a/sequencer.c b/sequencer.c
      --- a/sequencer.c
      +++ b/sequencer.c
     @@
    - 	return 0;
    - }
    - 
    --/*
    -- * Add commands after pick and (series of) squash/fixup commands
    -- * in the todo list.
    -- */
    +  * Add commands after pick and (series of) squash/fixup commands
    +  * in the todo list.
    +  */
     -int sequencer_add_exec_commands(struct repository *r,
     -				const char *commands)
     +static void todo_list_add_exec_commands(struct todo_list *todo_list,
    @@ -115,7 +115,7 @@
     -	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
     -		return error(_("could not read '%s'."), todo_file);
     +	base_items = xcalloc(commands->nr, sizeof(struct todo_item));
    -+	for (i = 0; i < commands->nr; ++i) {
    ++	for (i = 0; i < commands->nr; i++) {
     +		size_t command_len = strlen(commands->items[i].string);
      
     -	if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
    @@ -134,9 +134,10 @@
      
      	/*
     @@
    + 	 * are considered part of the pick, so we insert the commands *after*
      	 * those chains if there are any.
      	 */
    - 	insert = -1;
    +-	insert = -1;
     -	for (i = 0; i < todo_list.nr; i++) {
     -		enum todo_command command = todo_list.items[i].command;
     -
    @@ -152,21 +153,25 @@
     -				      todo_list.items[insert].offset_in_buf +
     -				      offset, commands, commands_len);
     -			offset += commands_len;
    +-			insert = -1;
    ++	insert = 0;
     +	for (i = 0; i < todo_list->nr; i++) {
     +		enum todo_command command = todo_list->items[i].command;
    -+		if (insert >= 0 && command != TODO_COMMENT && !is_fixup(command)) {
    ++		if (insert && !is_fixup(command)) {
     +			ALLOC_GROW(items, nr + commands->nr, alloc);
     +			COPY_ARRAY(items + nr, base_items, commands->nr);
     +			nr += commands->nr;
    - 			insert = -1;
    ++
    ++			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))
    - 			insert = i + 1;
    ++			insert = 1;
      	}
      
      	/* insert or append final <commands> */
    @@ -175,7 +180,7 @@
     -			      offset, commands, commands_len);
     -	else if (insert >= 0 || !offset)
     -		strbuf_add(buf, commands, commands_len);
    -+	if (insert >= 0 || nr == todo_list->nr) {
    ++	if (insert || nr == todo_list->nr) {
     +		ALLOC_GROW(items, nr + commands->nr, alloc);
     +		COPY_ARRAY(items + nr, base_items, commands->nr);
     +		nr += commands->nr;
    @@ -189,10 +194,6 @@
     +}
      
     -	i = write_message(buf->buf, buf->len, todo_file, 0);
    -+/*
    -+ * Add commands after pick and (series of) squash/fixup commands
    -+ * in the todo list.
    -+ */
     +int sequencer_add_exec_commands(struct repository *r,
     +				struct string_list *commands)
     +{
 8:  ecc684c833 =  8:  640cb7aa54 sequencer: refactor rearrange_squash() to work on a todo_list
 9:  4de36e9e76 =  9:  bef1970c88 sequencer: make sequencer_make_script() write its script to a strbuf
10:  d5af79282c ! 10:  48ee37a32a sequencer: change complete_action() to use the refactored functions
    @@ -197,14 +197,6 @@
      
      	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
      		return error(_("could not skip unnecessary pick commands"));
    - 
    - 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
    - 		return -1;
    --;
    -+
    - 	if (require_clean_work_tree(r, "rebase", "", 1, 1))
    - 		return -1;
    - 
     
      diff --git a/sequencer.h b/sequencer.h
      --- a/sequencer.h
11:  b04e1fc692 ! 11:  bc89fbfea6 sequencer: refactor skip_unnecessary_picks() to work on a todo_list
    @@ -38,7 +38,7 @@
     -static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
     +static int skip_unnecessary_picks(struct repository *r,
     +				  struct todo_list *todo_list,
    -+				  struct object_id *output_oid)
    ++				  struct object_id *base_oid)
      {
     -	const char *todo_file = rebase_path_todo();
     -	struct strbuf buf = STRBUF_INIT;
    @@ -77,7 +77,14 @@
      				oid_to_hex(&item->commit->object.oid));
      		}
     @@
    - 		oidcpy(output_oid, &item->commit->object.oid);
    + 		if (item->commit->parents->next)
    + 			break; /* merge commit */
    + 		parent_oid = &item->commit->parents->item->object.oid;
    +-		if (!oideq(parent_oid, output_oid))
    ++		if (!oideq(parent_oid, base_oid))
    + 			break;
    +-		oidcpy(output_oid, &item->commit->object.oid);
    ++		oidcpy(base_oid, &item->commit->object.oid);
      	}
      	if (i > 0) {
     -		int offset = get_item_line_offset(&todo_list, i);
    @@ -112,7 +119,7 @@
     -		if (is_fixup(peek_command(&todo_list, 0)))
     -			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
     +		if (is_fixup(peek_command(todo_list, 0)))
    -+			record_in_rewritten(output_oid, peek_command(todo_list, 0));
    ++			record_in_rewritten(base_oid, peek_command(todo_list, 0));
      	}
      
     -	todo_list_release(&todo_list);
12:  7cc97f77a8 = 12:  a754d0da96 rebase-interactive: use todo_list_write_to_file() in edit_todo_list()
13:  77056f58a2 = 13:  031e4de856 rebase-interactive: append_todo_help() changes
14:  3591e06b7d ! 14:  268998924b rebase-interactive: rewrite edit_todo_list() to handle the initial edit
    @@ -24,21 +24,21 @@
     +	const char *todo_file = rebase_path_todo();
     +	struct todo_list todo_list = TODO_LIST_INIT,
     +		new_todo = 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);
     +
     +	strbuf_stripspace(&todo_list.buf, 1);
    -+	if (!edit_todo_list(the_repository, &todo_list,
    -+			    &new_todo, NULL, NULL, flags) &&
    -+	    todo_list_write_to_file(the_repository, &new_todo, todo_file, NULL, NULL,
    -+				    -1, flags & ~(TODO_LIST_SHORTEN_IDS)) < 0)
    -+		return error_errno(_("could not write '%s'"), todo_file);
    ++	res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
    ++	if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
    ++					    NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
    ++		res = error_errno(_("could not write '%s'"), todo_file);
     +
     +	todo_list_release(&todo_list);
     +	todo_list_release(&new_todo);
     +
    -+	return 0;
    ++	return res;
     +}
     +
      static int get_revision_ranges(const char *upstream, const char *onto,
    @@ -79,40 +79,39 @@
     -				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
     -		todo_list_release(&todo_list);
     -		return -1;
    +-	}
     +	unsigned initial = shortrevisions && shortonto;
    -+
    -+	if (initial) {
    -+		todo_list_write_to_file(r, todo_list, todo_file, shortrevisions, shortonto,
    -+					-1, flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP);
    -+
    -+		if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
    -+			return error(_("could not copy '%s' to '%s'."), todo_file,
    -+				     rebase_path_todo_backup());
    -+	} else {
    -+		todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
    -+		todo_list_write_to_file(r, todo_list, todo_file, NULL, NULL, -1,
    -+					flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP);
    - 	}
      
     -	strbuf_reset(&todo_list.buf);
     -	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
     -		todo_list_release(&todo_list);
     -		return -1;
     -	}
    -+	if (launch_sequence_editor(todo_file, &new_todo->buf, NULL))
    -+		return -2;
    ++	if (!initial)
    ++		todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
      
     -	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
     -		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
     -					      flags & ~(TODO_LIST_SHORTEN_IDS));
    -+	strbuf_stripspace(&new_todo->buf, 1);
    -+	if (initial && new_todo->buf.len == 0)
    -+		return -3;
    ++	if (todo_list_write_to_file(r, todo_list, todo_file, shortrevisions, shortonto,
    ++				    -1, flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
    ++		return error_errno(_("could not write '%s'"), todo_file);
      
     -	todo_list_release(&todo_list);
     -	return res;
    ++	if (initial && copy_file(rebase_path_todo_backup(), todo_file, 0666))
    ++		return error(_("could not copy '%s' to '%s'."), todo_file,
    ++			     rebase_path_todo_backup());
    ++
    ++	if (launch_sequence_editor(todo_file, &new_todo->buf, NULL))
    ++		return -2;
    ++
    ++	strbuf_stripspace(&new_todo->buf, 1);
    ++	if (initial && new_todo->buf.len == 0)
    ++		return -3;
    ++
     +	if (!initial)
    -+		todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);
    ++		return todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);
     +
     +	return 0;
      }
15:  0b29fca27f = 15:  6f1274a33c sequencer: use edit_todo_list() in complete_action()
16:  5ab34416af <  -:  ---------- rebase--interactive: move transform_todo_file() to rebase--interactive.c
 -:  ---------- > 16:  f57a7405d0 rebase--interactive: move several functions to rebase--interactive.c
Signature · 1 line
2.20.1
#148 lore raw

PATCH v7 1/16 sequencer: changes in parse_insn_buffer()

This clears the number of items of a todo_list before parsing it to allow to parse the same list multiple times without issues. As its items are not dynamically allocated, or don’t need to allocate memory, no additionnal memory management is required here.

Furthermore, if a line is invalid, the type of the corresponding command is set to a garbage value, and its argument is defined properly. This will allow to recreate the text of a todo list from its commands, even if one of them is incorrect.

---
No changes since v6.

 sequencer.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
sequencer.c +6 -1
index b68bca0bef..d605199a54 100644
@@ -2141,6 +2141,8 @@ static int parse_insn_buffer(struct repository *r, char *buf,
 	char *p = buf, *next_p;
 	int i, res = 0, fixup_okay = file_exists(rebase_path_done());
 
+	todo_list->current = todo_list->nr = 0;
+
 	for (i = 1; *p; i++, p = next_p) {
 		char *eol = strchrnul(p, '\n');
 
@@ -2154,7 +2156,10 @@ static int parse_insn_buffer(struct repository *r, char *buf,
 		if (parse_insn_line(r, item, p, eol)) {
 			res = error(_("invalid line %d: %.*s"),
 				i, (int)(eol - p), p);
-			item->command = TODO_NOOP;
+			item->command = TODO_COMMENT + 1;
+			item->arg = p;
+			item->arg_len = (int)(eol - p);
+			item->commit = NULL;
 		}
 
 		if (fixup_okay)
Signature · 1 line
2.20.1
#149 lore raw

PATCH v7 2/16 sequencer: make the todo_list structure public

In reply to Alban Gruin

This makes the structures todo_list and todo_item, and the functions todo_list_release() and parse_insn_buffer(), accessible outside of sequencer.c.

---
No changes since v6.

 sequencer.c | 69 ++++++++++-------------------------------------------
 sequencer.h | 50 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 57 deletions(-)
sequencer.c +12 -57
index d605199a54..25cc7a9a91 100644
@@ -1510,32 +1510,6 @@ static int allow_empty(struct repository *r,
 		return 1;
 }
 
-/*
- * Note that ordering matters in this enum. Not only must it match the mapping
- * below, it is also divided into several sections that matter.  When adding
- * new commands, make sure you add it in the right section.
- */
-enum todo_command {
-	/* commands that handle commits */
-	TODO_PICK = 0,
-	TODO_REVERT,
-	TODO_EDIT,
-	TODO_REWORD,
-	TODO_FIXUP,
-	TODO_SQUASH,
-	/* commands that do something else than handling a single commit */
-	TODO_EXEC,
-	TODO_BREAK,
-	TODO_LABEL,
-	TODO_RESET,
-	TODO_MERGE,
-	/* commands that do nothing but are counted for reporting progress */
-	TODO_NOOP,
-	TODO_DROP,
-	/* comments (not counted for reporting progress) */
-	TODO_COMMENT
-};
-
 static struct {
 	char c;
 	const char *str;
@@ -2012,26 +1986,7 @@ enum todo_item_flags {
 	TODO_EDIT_MERGE_MSG = 1
 };
 
-struct todo_item {
-	enum todo_command command;
-	struct commit *commit;
-	unsigned int flags;
-	const char *arg;
-	int arg_len;
-	size_t offset_in_buf;
-};
-
-struct todo_list {
-	struct strbuf buf;
-	struct todo_item *items;
-	int nr, alloc, current;
-	int done_nr, total_nr;
-	struct stat_data stat;
-};
-
-#define TODO_LIST_INIT { STRBUF_INIT }
-
-static void todo_list_release(struct todo_list *todo_list)
+void todo_list_release(struct todo_list *todo_list)
 {
 	strbuf_release(&todo_list->buf);
 	FREE_AND_NULL(todo_list->items);
@@ -2134,8 +2089,8 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	return !item->commit;
 }
 
-static int parse_insn_buffer(struct repository *r, char *buf,
-			     struct todo_list *todo_list)
+int todo_list_parse_insn_buffer(struct repository *r, char *buf,
+				struct todo_list *todo_list)
 {
 	struct todo_item *item;
 	char *p = buf, *next_p;
@@ -2234,7 +2189,7 @@ static int read_populate_todo(struct repository *r,
 		return error(_("could not stat '%s'"), todo_file);
 	fill_stat_data(&todo_list->stat, &st);
 
-	res = parse_insn_buffer(r, todo_list->buf.buf, todo_list);
+	res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
 	if (res) {
 		if (is_rebase_i(opts))
 			return error(_("please fix this using "
@@ -2265,7 +2220,7 @@ static int read_populate_todo(struct repository *r,
 		FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
 
 		if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
-		    !parse_insn_buffer(r, done.buf.buf, &done))
+		    !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
 			todo_list->done_nr = count_commands(&done);
 		else
 			todo_list->done_nr = 0;
@@ -4556,7 +4511,7 @@ int sequencer_add_exec_commands(struct repository *r,
 	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
+	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);
 	}
@@ -4612,7 +4567,7 @@ int transform_todos(struct repository *r, unsigned flags)
 	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
+	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);
 	}
@@ -4698,7 +4653,7 @@ int check_todo_list(struct repository *r)
 		goto leave_check;
 	}
 	advise_to_edit_todo = res =
-		parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+		todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
 
 	if (res || check_level == MISSING_COMMIT_CHECK_IGNORE)
 		goto leave_check;
@@ -4717,7 +4672,7 @@ int check_todo_list(struct repository *r)
 		goto leave_check;
 	}
 	strbuf_release(&todo_file);
-	res = !!parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+	res = !!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
 
 	/* Find commits in git-rebase-todo.backup yet unseen */
 	for (i = todo_list.nr - 1; i >= 0; i--) {
@@ -4799,7 +4754,7 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 
 	if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
 		return -1;
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
+	if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
 		todo_list_release(&todo_list);
 		return -1;
 	}
@@ -4887,7 +4842,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	if (strbuf_read_file(buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, buf->buf, &todo_list)) {
+	if (todo_list_parse_insn_buffer(r, buf->buf, &todo_list)) {
 		todo_list_release(&todo_list);
 		return error(_("unusable todo list: '%s'"), todo_file);
 	}
@@ -4995,7 +4950,7 @@ int rearrange_squash(struct repository *r)
 
 	if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
 		return -1;
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
+	if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
 		todo_list_release(&todo_list);
 		return -1;
 	}
sequencer.h +50 -0

56 lines not on this page · raw message

Signature · 1 line
2.20.1
#150 lore raw

PATCH v7 3/16 sequencer: remove the 'arg' field from todo_item

In reply to Alban Gruin

The 'arg' field of todo_item used to store the address of the first byte of the parameter of a command in a todo list. It was associated with the length of the parameter (the 'arg_len' field).

This replaces the 'arg' field by 'arg_offset'. This new field does not store the address of the parameter, but the position of the first character of the parameter in the buffer. todo_item_get_arg() is added to return the address of the parameter of an item.

This will prevent todo_list_add_exec_commands() from having to do awful pointer arithmetics when growing the todo list buffer.

---
No changes since v6.

 sequencer.c | 67 ++++++++++++++++++++++++++++++-----------------------
 sequencer.h |  6 +++--
 2 files changed, 42 insertions(+), 31 deletions(-)
sequencer.c +38 -29
index 25cc7a9a91..c844a9b7f3 100644
@@ -1999,8 +1999,14 @@ static struct todo_item *append_new_todo(struct todo_list *todo_list)
 	return todo_list->items + todo_list->nr++;
 }
 
+const char *todo_item_get_arg(struct todo_list *todo_list,
+			      struct todo_item *item)
+{
+	return todo_list->buf.buf + item->arg_offset;
+}
+
 static int parse_insn_line(struct repository *r, struct todo_item *item,
-			   const char *bol, char *eol)
+			   const char *buf, const char *bol, char *eol)
 {
 	struct object_id commit_oid;
 	char *end_of_object_name;
@@ -2014,7 +2020,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
 		item->command = TODO_COMMENT;
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = eol - bol;
 		return 0;
 	}
@@ -2041,7 +2047,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = eol - bol;
 		return 0;
 	}
@@ -2053,7 +2059,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
 	    item->command == TODO_RESET) {
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = (int)(eol - bol);
 		return 0;
 	}
@@ -2067,7 +2073,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 		} else {
 			item->flags |= TODO_EDIT_MERGE_MSG;
 			item->commit = NULL;
-			item->arg = bol;
+			item->arg_offset = bol - buf;
 			item->arg_len = (int)(eol - bol);
 			return 0;
 		}
@@ -2079,8 +2085,9 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	status = get_oid(bol, &commit_oid);
 	*end_of_object_name = saved;
 
-	item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
-	item->arg_len = (int)(eol - item->arg);
+	bol = end_of_object_name + strspn(end_of_object_name, " \t");
+	item->arg_offset = bol - buf;
+	item->arg_len = (int)(eol - bol);
 
 	if (status < 0)
 		return -1;
@@ -2108,11 +2115,11 @@ int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 
 		item = append_new_todo(todo_list);
 		item->offset_in_buf = p - todo_list->buf.buf;
-		if (parse_insn_line(r, item, p, eol)) {
+		if (parse_insn_line(r, item, buf, p, eol)) {
 			res = error(_("invalid line %d: %.*s"),
 				i, (int)(eol - p), p);
 			item->command = TODO_COMMENT + 1;
-			item->arg = p;
+			item->arg_offset = p - buf;
 			item->arg_len = (int)(eol - p);
 			item->commit = NULL;
 		}
@@ -2452,7 +2459,7 @@ static int walk_revs_populate_todo(struct todo_list *todo_list,
 
 		item->command = command;
 		item->commit = commit;
-		item->arg = NULL;
+		item->arg_offset = 0;
 		item->arg_len = 0;
 		item->offset_in_buf = todo_list->buf.len;
 		subject_len = find_commit_subject(commit_buffer, &subject);
@@ -3491,6 +3498,8 @@ static int pick_commits(struct repository *r,
 
 	while (todo_list->current < todo_list->nr) {
 		struct todo_item *item = todo_list->items + todo_list->current;
+		const char *arg = todo_item_get_arg(todo_list, item);
+
 		if (save_todo(todo_list, opts))
 			return -1;
 		if (is_rebase_i(opts)) {
@@ -3542,10 +3551,9 @@ static int pick_commits(struct repository *r,
 					fprintf(stderr,
 						_("Stopped at %s...  %.*s\n"),
 						short_commit_name(commit),
-						item->arg_len, item->arg);
+						item->arg_len, arg);
 				return error_with_patch(r, commit,
-					item->arg, item->arg_len, opts, res,
-					!res);
+					arg, item->arg_len, opts, res, !res);
 			}
 			if (is_rebase_i(opts) && !res)
 				record_in_rewritten(&item->commit->object.oid,
@@ -3554,7 +3562,7 @@ static int pick_commits(struct repository *r,
 				if (res == 1)
 					intend_to_amend();
 				return error_failed_squash(r, item->commit, opts,
-					item->arg_len, item->arg);
+					item->arg_len, arg);
 			} else if (res && is_rebase_i(opts) && item->commit) {
 				int to_amend = 0;
 				struct object_id oid;
@@ -3573,16 +3581,16 @@ static int pick_commits(struct repository *r,
 					to_amend = 1;
 
 				return res | error_with_patch(r, item->commit,
-						item->arg, item->arg_len, opts,
+						arg, item->arg_len, opts,
 						res, to_amend);
 			}
 		} else if (item->command == TODO_EXEC) {
-			char *end_of_arg = (char *)(item->arg + item->arg_len);
+			char *end_of_arg = (char *)(arg + item->arg_len);
 			int saved = *end_of_arg;
 			struct stat st;
 
 			*end_of_arg = '\0';
-			res = do_exec(r, item->arg);
+			res = do_exec(r, arg);
 			*end_of_arg = saved;
 
 			/* Reread the todo file if it has changed. */
@@ -3599,14 +3607,14 @@ static int pick_commits(struct repository *r,
 				todo_list->current = -1;
 			}
 		} else if (item->command == TODO_LABEL) {
-			if ((res = do_label(r, item->arg, item->arg_len)))
+			if ((res = do_label(r, arg, item->arg_len)))
 				reschedule = 1;
 		} else if (item->command == TODO_RESET) {
-			if ((res = do_reset(r, item->arg, item->arg_len, opts)))
+			if ((res = do_reset(r, arg, item->arg_len, opts)))
 				reschedule = 1;
 		} else if (item->command == TODO_MERGE) {
 			if ((res = do_merge(r, item->commit,
-					    item->arg, item->arg_len,
+					    arg, item->arg_len,
 					    item->flags, opts)) < 0)
 				reschedule = 1;
 			else if (item->commit)
@@ -3615,9 +3623,8 @@ static int pick_commits(struct repository *r,
 			if (res > 0)
 				/* failed with merge conflicts */
 				return error_with_patch(r, item->commit,
-							item->arg,
-							item->arg_len, opts,
-							res, 0);
+							arg, item->arg_len,
+							opts, res, 0);
 		} else if (!is_noop(item->command))
 			return error(_("unknown command %d"), item->command);
 
@@ -3632,9 +3639,8 @@ static int pick_commits(struct repository *r,
 			if (item->commit)
 				return error_with_patch(r,
 							item->commit,
-							item->arg,
-							item->arg_len, opts,
-							res, 0);
+							arg, item->arg_len,
+							opts, res, 0);
 		}
 
 		todo_list->current++;
@@ -4575,7 +4581,8 @@ int transform_todos(struct repository *r, unsigned flags)
 	for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
 		/* if the item is not a command write it and continue */
 		if (item->command >= TODO_COMMENT) {
-			strbuf_addf(&buf, "%.*s\n", item->arg_len, item->arg);
+			strbuf_addf(&buf, "%.*s\n", item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 			continue;
 		}
 
@@ -4605,7 +4612,8 @@ int transform_todos(struct repository *r, unsigned flags)
 		if (!item->arg_len)
 			strbuf_addch(&buf, '\n');
 		else
-			strbuf_addf(&buf, " %.*s\n", item->arg_len, item->arg);
+			strbuf_addf(&buf, " %.*s\n", item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 	}
 
 	i = write_message(buf.buf, buf.len, todo_file, 0);
@@ -4681,7 +4689,8 @@ int check_todo_list(struct repository *r)
 		if (commit && !*commit_seen_at(&commit_seen, commit)) {
 			strbuf_addf(&missing, " - %s %.*s\n",
 				    short_commit_name(commit),
-				    item->arg_len, item->arg);
+				    item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 			*commit_seen_at(&commit_seen, commit) = 1;
 		}
 	}
sequencer.h +4 -2
index c6360bac66..50d552429c 100644
@@ -104,9 +104,9 @@ struct todo_item {
 	enum todo_command command;
 	struct commit *commit;
 	unsigned int flags;
-	const char *arg;
 	int arg_len;
-	size_t offset_in_buf;
+	/* The offset of the command and its argument in the strbuf */
+	size_t offset_in_buf, arg_offset;
 };
 
 struct todo_list {
@@ -122,6 +122,8 @@ struct todo_list {
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
 void todo_list_release(struct todo_list *todo_list);
+const char *todo_item_get_arg(struct todo_list *todo_list,
+			      struct todo_item *item);
 
 /* Call this to setup defaults before parsing command line options */
 void sequencer_init_config(struct replay_opts *opts);
Signature · 1 line
2.20.1
#151 lore raw

PATCH v7 4/16 sequencer: refactor transform_todos() to work on a todo_list

In reply to Alban Gruin

This refactors transform_todos() to work on a todo_list. The function is renamed todo_list_transform().

As rebase -p still need to check the todo list from the disk, a new function is introduced, transform_todo_file(). It is still used by complete_action() and edit_todo_list() for now, but they will be replaced in a future commit.

todo_list_transform() is not a static function, because it will be used by edit_todo_list() from rebase-interactive.c in a future commit.

---
No changes since v6.

 builtin/rebase--interactive.c |  2 +-
 rebase-interactive.c          |  4 +--
 sequencer.c                   | 54 +++++++++++++++++++++++------------
 sequencer.h                   |  4 ++-
 4 files changed, 42 insertions(+), 22 deletions(-)
builtin/rebase--interactive.c +1 -1
index dd2a55ab1d..0898eb4c59 100644
@@ -253,7 +253,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	case SHORTEN_OIDS:
 	case EXPAND_OIDS:
-		ret = transform_todos(the_repository, flags);
+		ret = transform_todo_file(the_repository, flags);
 		break;
 	case CHECK_TODO_LIST:
 		ret = check_todo_list(the_repository);
rebase-interactive.c +2 -2
index 68aff1dac2..842fa07e7e 100644
@@ -69,7 +69,7 @@ int edit_todo_list(struct repository *r, unsigned flags)
 
 	strbuf_release(&buf);
 
-	transform_todos(r, flags | TODO_LIST_SHORTEN_IDS);
+	transform_todo_file(r, flags | TODO_LIST_SHORTEN_IDS);
 
 	if (strbuf_read_file(&buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
@@ -85,7 +85,7 @@ int edit_todo_list(struct repository *r, unsigned flags)
 	if (launch_sequence_editor(todo_file, NULL, NULL))
 		return -1;
 
-	transform_todos(r, flags & ~(TODO_LIST_SHORTEN_IDS));
+	transform_todo_file(r, flags & ~(TODO_LIST_SHORTEN_IDS));
 
 	return 0;
 }
sequencer.c +36 -18

89 lines not on this page · raw message

sequencer.h +3 -1
index 50d552429c..2ddb20cbc1 100644
@@ -121,6 +121,8 @@ struct todo_list {
 
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
+void todo_list_transform(struct repository *r, struct todo_list *todo_list,
+			 unsigned flags);
 void todo_list_release(struct todo_list *todo_list);
 const char *todo_item_get_arg(struct todo_list *todo_list,
 			      struct todo_item *item);
@@ -148,7 +150,7 @@ int sequencer_make_script(struct repository *repo, FILE *out,
 			  unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
-int transform_todos(struct repository *r, unsigned flags);
+int transform_todo_file(struct repository *r, unsigned flags);
 enum missing_commit_check_level get_missing_commit_check_level(void);
 int check_todo_list(struct repository *r);
 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
Signature · 1 line
2.20.1
#152 lore raw

PATCH v7 5/16 sequencer: introduce todo_list_write_to_file()

In reply to Alban Gruin

This introduces a new function to recreate the text of a todo list from its commands and write it to a file. This will be useful as the next few commits will change the use of the buffer in struct todo_list so it will no longer be a mirror of the file on disk.

This functionality already exists in todo_list_transform(), but this function was made to replace the buffer of a todo list, which is not what we want here. Thus, the part of todo_list_transform() that replaces the buffer is dropped, and the function is renamed todo_list_to_strbuf(). It is called by todo_list_write_to_file() to fill the buffer to write to the disk.

todo_list_write_to_file() can also take care of appending the help text to the buffer before writing it to the disk, or to write only the first n items of the list. This feature will be used by skip_unnecessary_picks(), which has to write done commands in a file.

---
No changes since v6.

 sequencer.c | 61 +++++++++++++++++++++++++++++++++++------------------
 sequencer.h | 11 ++++++----
 2 files changed, 48 insertions(+), 24 deletions(-)
sequencer.c +41 -20
index 346706029c..4809b22ce4 100644
@@ -4562,26 +4562,28 @@ int sequencer_add_exec_commands(struct repository *r,
 	return i;
 }
 
-void todo_list_transform(struct repository *r, struct todo_list *todo_list,
-			 unsigned flags)
+static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
+				struct strbuf *buf, int num, unsigned flags)
 {
-	struct strbuf buf = STRBUF_INIT;
 	struct todo_item *item;
-	int i;
+	int i, max = todo_list->nr;
 
-	for (item = todo_list->items, i = 0; i < todo_list->nr; i++, item++) {
+	if (num > 0 && num < max)
+		max = num;
+
+	for (item = todo_list->items, i = 0; i < max; i++, item++) {
 		/* if the item is not a command write it and continue */
 		if (item->command >= TODO_COMMENT) {
-			strbuf_addf(&buf, "%.*s\n", item->arg_len,
+			strbuf_addf(buf, "%.*s\n", item->arg_len,
 				    todo_item_get_arg(todo_list, item));
 			continue;
 		}
 
 		/* add command to the buffer */
 		if (flags & TODO_LIST_ABBREVIATE_CMDS)
-			strbuf_addch(&buf, command_to_char(item->command));
+			strbuf_addch(buf, command_to_char(item->command));
 		else
-			strbuf_addstr(&buf, command_to_string(item->command));
+			strbuf_addstr(buf, command_to_string(item->command));
 
 		/* add commit id */
 		if (item->commit) {
@@ -4591,28 +4593,48 @@ void todo_list_transform(struct repository *r, struct todo_list *todo_list,
 
 			if (item->command == TODO_MERGE) {
 				if (item->flags & TODO_EDIT_MERGE_MSG)
-					strbuf_addstr(&buf, " -c");
+					strbuf_addstr(buf, " -c");
 				else
-					strbuf_addstr(&buf, " -C");
+					strbuf_addstr(buf, " -C");
 			}
 
-			strbuf_addf(&buf, " %s", oid);
+			strbuf_addf(buf, " %s", oid);
 		}
 
 		/* add all the rest */
 		if (!item->arg_len)
-			strbuf_addch(&buf, '\n');
+			strbuf_addch(buf, '\n');
 		else
-			strbuf_addf(&buf, " %.*s\n", item->arg_len,
+			strbuf_addf(buf, " %.*s\n", item->arg_len,
 				    todo_item_get_arg(todo_list, item));
 	}
+}
 
-	strbuf_reset(&todo_list->buf);
-	strbuf_add(&todo_list->buf, buf.buf, buf.len);
+int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
+			    const char *file, const char *shortrevisions,
+			    const char *shortonto, int num, unsigned flags)
+{
+	int edit_todo = !(shortrevisions && shortonto), res;
+	struct strbuf buf = STRBUF_INIT;
+
+	todo_list_to_strbuf(r, todo_list, &buf, num, flags);
+
+	if (flags & TODO_LIST_APPEND_TODO_HELP) {
+		int command_count = count_commands(todo_list);
+		if (!edit_todo) {
+			strbuf_addch(&buf, '\n');
+			strbuf_commented_addf(&buf, Q_("Rebase %s onto %s (%d command)",
+						       "Rebase %s onto %s (%d commands)",
+						       command_count),
+					      shortrevisions, shortonto, command_count);
+		}
+		append_todo_help(edit_todo, flags & TODO_LIST_KEEP_EMPTY, &buf);
+	}
+
+	res = write_message(buf.buf, buf.len, file, 0);
 	strbuf_release(&buf);
 
-	if (todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list))
-		BUG("unusable todo list");
+	return res;
 }
 
 int transform_todo_file(struct repository *r, unsigned flags)
@@ -4629,9 +4651,8 @@ int transform_todo_file(struct repository *r, unsigned flags)
 		return error(_("unusable todo list: '%s'"), todo_file);
 	}
 
-	todo_list_transform(r, &todo_list, flags);
-
-	res = write_message(todo_list.buf.buf, todo_list.buf.len, todo_file, 0);
+	res = todo_list_write_to_file(r, &todo_list, todo_file,
+				      NULL, NULL, -1, flags);
 	todo_list_release(&todo_list);
 
 	if (res)
sequencer.h +7 -4
index 2ddb20cbc1..7278f9675b 100644
@@ -121,8 +121,9 @@ struct todo_list {
 
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
-void todo_list_transform(struct repository *r, struct todo_list *todo_list,
-			 unsigned flags);
+int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
+			    const char *file, const char *shortrevisions,
+			    const char *shortonto, int num, unsigned flags);
 void todo_list_release(struct todo_list *todo_list);
 const char *todo_item_get_arg(struct todo_list *todo_list,
 			      struct todo_item *item);
@@ -145,8 +146,10 @@ int sequencer_remove_state(struct replay_opts *opts);
  * commits should be rebased onto the new base, this flag needs to be passed.
  */
 #define TODO_LIST_REBASE_COUSINS (1U << 4)
-int sequencer_make_script(struct repository *repo, FILE *out,
-			  int argc, const char **argv,
+#define TODO_LIST_APPEND_TODO_HELP (1U << 5)
+
+int sequencer_make_script(struct repository *r, FILE *out, int argc,
+			  const char **argv,
 			  unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
Signature · 1 line
2.20.1
#153 lore raw

PATCH v7 6/16 sequencer: refactor check_todo_list() to work on a todo_list

In reply to Alban Gruin

This refactors check_todo_list() to work on a todo_list to avoid redundant reads and writes to the disk. The function is renamed todo_list_check(). The parsing of the two todo lists is left to the caller.

As rebase -p still need to check the todo list from the disk, a new function is introduced, check_todo_list_from_file(). It reads the file from the disk, parses it, pass the todo_list to todo_list_check(), and writes it back to the disk.

As get_missing_commit_check_level() and the enum missing_commit_check_level are no longer needed inside of sequencer.c, they are moved to rebase-interactive.c, and made static again.

---
No changes since v6.

 builtin/rebase--interactive.c |   2 +-
 rebase-interactive.c          |  91 ++++++++++++++++++++++++-
 rebase-interactive.h          |   2 +
 sequencer.c                   | 121 +++++++---------------------------
 sequencer.h                   |   9 +--
 5 files changed, 117 insertions(+), 108 deletions(-)
builtin/rebase--interactive.c +1 -1
index 0898eb4c59..df19ccaeb9 100644
@@ -256,7 +256,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = transform_todo_file(the_repository, flags);
 		break;
 	case CHECK_TODO_LIST:
-		ret = check_todo_list(the_repository);
+		ret = check_todo_list_from_file(the_repository);
 		break;
 	case REARRANGE_SQUASH:
 		ret = rearrange_squash(the_repository);
rebase-interactive.c +90 -1

101 lines not on this page · raw message

rebase-interactive.h +2 -0
index 17b6c9f6d0..187b5032d6 100644
@@ -3,9 +3,11 @@
 
 struct strbuf;
 struct repository;
+struct todo_list;
 
 void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 		      struct strbuf *buf);
 int edit_todo_list(struct repository *r, unsigned flags);
+int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +23 -98

142 lines not on this page · raw message

sequencer.h +1 -8
index 7278f9675b..217353e9f0 100644
@@ -64,12 +64,6 @@ struct replay_opts {
 };
 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
 
-enum missing_commit_check_level {
-	MISSING_COMMIT_CHECK_IGNORE = 0,
-	MISSING_COMMIT_CHECK_WARN,
-	MISSING_COMMIT_CHECK_ERROR
-};
-
 int write_message(const void *buf, size_t len, const char *filename,
 		  int append_eol);
 
@@ -154,8 +148,7 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
 int transform_todo_file(struct repository *r, unsigned flags);
-enum missing_commit_check_level get_missing_commit_check_level(void);
-int check_todo_list(struct repository *r);
+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, const char *cmd,
Signature · 1 line
2.20.1
#154 lore raw

PATCH v7 7/16 sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

In reply to Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created. Items from the old list are copied across and new `exec' items are appended when necessary. This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command. This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  15 +++--
 sequencer.c                   | 109 +++++++++++++++++++++-------------
 sequencer.h                   |   5 +-
 3 files changed, 82 insertions(+), 47 deletions(-)
builtin/rebase--interactive.c +11 -4
index df19ccaeb9..c131fd4a27 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 				 const char *onto, const char *onto_name,
 				 const char *squash_onto, const char *head_name,
 				 const char *restrict_revision, char *raw_strategies,
-				 const char *cmd, unsigned autosquash)
+				 struct string_list *commands, unsigned autosquash)
 {
 	int ret;
 	const char *head_hash = NULL;
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 		discard_cache();
 		ret = complete_action(the_repository, opts, flags,
 				      shortrevisions, onto_name, onto,
-				      head_hash, cmd, autosquash);
+				      head_hash, commands, autosquash);
 	}
 
 	free(revisions);
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
 		*squash_onto = NULL, *upstream = NULL, *head_name = NULL,
 		*switch_to = NULL, *cmd = NULL;
+	struct string_list commands = STRING_LIST_INIT_DUP;
 	char *raw_strategies = NULL;
 	enum {
 		NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,
@@ -221,6 +222,11 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);
+		--commands.nr;
+	}
+
 	switch (command) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +234,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;
@@ -262,11 +268,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
 	}
 
+	string_list_clear(&commands, 1);
 	return !!ret;
 }
sequencer.c +68 -41

143 lines not on this page · raw message

sequencer.h +3 -2
index 217353e9f0..87d04a3b9b 100644
@@ -146,12 +146,13 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 			  const char **argv,
 			  unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r, const char *command);
+int sequencer_add_exec_commands(struct repository *r,
+				struct string_list *commands);
 int transform_todo_file(struct repository *r, unsigned flags);
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
 int rearrange_squash(struct repository *r);
 
Signature · 1 line
2.20.1
#155 lore raw

Re: [PATCH v7 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

Hi Alban

I think this is almost there, I've got a couple of small comments below.

Quoted 59 lines · Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created. Items from the old list are copied across and new `exec' items are appended when necessary. This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command. This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  15 +++--
 sequencer.c                   | 109 +++++++++++++++++++++-------------
 sequencer.h                   |   5 +-
 3 files changed, 82 insertions(+), 47 deletions(-)
builtin/rebase--interactive.c +3 -2
index df19ccaeb9..c131fd4a27 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 				 const char *onto, const char *onto_name,
 				 const char *squash_onto, const char *head_name,
 				 const char *restrict_revision, char *raw_strategies,
-				 const char *cmd, unsigned autosquash)
+				 struct string_list *commands, unsigned autosquash)
 {
 	int ret;
 	const char *head_hash = NULL;
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 		discard_cache();
 		ret = complete_action(the_repository, opts, flags,
 				      shortrevisions, onto_name, onto,
-				      head_hash, cmd, autosquash);
+				      head_hash, commands, autosquash);
 	}
 
 	free(revisions);
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
 		*squash_onto = NULL, *upstream = NULL, *head_name = NULL,
 		*switch_to = NULL, *cmd = NULL;
+	struct string_list commands = STRING_LIST_INIT_DUP;
 	char *raw_strategies = NULL;
 	enum {
 		NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 226

Quoted 5 lines
builtin/rebase--interactive.c +2 -0
@@ -221,6 +222,11 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);

I'd suggest a comment along the lines of
/* As cmd always ends with a newline the last item is empty */

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 227

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+		--commands.nr;

Style: commands.nr--

Quoted 15 lines
builtin/rebase--interactive.c +3 -1
+	}
+
 	switch (command) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +234,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 275

Quoted 9 lines
builtin/rebase--interactive.c +1 -1
@@ -262,11 +268,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
 	}

Before freeing the string list it would be good to reset the number of items with commands.nr++ (with a comment explaining why) so the NUL in the last item gets freed.

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 277

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+	string_list_clear(&commands, 1);

As we don't use item.util I think the second argument would be better as 0.

Quoted 57 lines
builtin/rebase--interactive.c +0 -0
 	return !!ret;
 }
sequencer.c +18 -19
index 99e12c751e..82ca3432cd 100644
@@ -4505,21 +4505,27 @@ int sequencer_make_script(struct repository *r, FILE *out,
  * Add commands after pick and (series of) squash/fixup commands
  * in the todo list.
  */
-int sequencer_add_exec_commands(struct repository *r,
-				const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+					struct string_list *commands)
 {
-	const char *todo_file = rebase_path_todo();
-	struct todo_list todo_list = TODO_LIST_INIT;
-	struct strbuf *buf = &todo_list.buf;
-	size_t offset = 0, commands_len = strlen(commands);
-	int i, insert;
+	struct strbuf *buf = &todo_list->buf;
+	size_t base_offset = buf->len;
+	int i, insert, nr = 0, alloc = 0;
+	struct todo_item *items = NULL, *base_items = NULL;
 
-	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-		return error(_("could not read '%s'."), todo_file);
+	base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+	for (i = 0; i < commands->nr; i++) {
+		size_t command_len = strlen(commands->items[i].string);
 
-	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);
+		strbuf_addstr(buf, commands->items[i].string);
+		strbuf_addch(buf, '\n');
+
+		base_items[i].command = TODO_EXEC;
+		base_items[i].offset_in_buf = base_offset;
+		base_items[i].arg_offset = base_offset + strlen("exec ");
+		base_items[i].arg_len = command_len - strlen("exec ");
+
+		base_offset += command_len + 1;
 	}
 
 	/*
@@ -4527,39 +4533,60 @@ int sequencer_add_exec_commands(struct repository *r,
 	 * are considered part of the pick, so we insert the commands *after*
 	 * those chains if there are any.
 	 */
-	insert = -1;
-	for (i = 0; i < todo_list.nr; i++) {
-		enum todo_command command = todo_list.items[i].command;
-
-		if (insert >= 0) {
-			/* skip fixup/squash chains */
-			if (command == TODO_COMMENT)

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4546

Quoted 10 lines
sequencer.c +0 -10
-				continue;
-			else if (is_fixup(command)) {
-				insert = i + 1;
-				continue;
-			}
-			strbuf_insert(buf,
-				      todo_list.items[insert].offset_in_buf +
-				      offset, commands, commands_len);
-			offset += commands_len;
-			insert = -1;

I like the simplification of using insert as a flag. Perhaps we should document the assumptions. Maybe something like

We insert the exec commands immediately after rearranging any fixups and before the user edits the list. This means that a fixup chain can never contain comments (any comments are empty picks that have been commented out the the user did not specify --keep-empty) and so it is safe to insert the exec command without looking at the command following the comment.

Quoted 7 lines
sequencer.c +7 -0
+	insert = 0;
+	for (i = 0; i < todo_list->nr; i++) {
+		enum todo_command command = todo_list->items[i].command;
+		if (insert && !is_fixup(command)) {
+			ALLOC_GROW(items, nr + commands->nr, alloc);
+			COPY_ARRAY(items + nr, base_items, commands->nr);
+			nr += commands->nr;

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4550

Quoted 10 lines
sequencer.c +6 -2
+
+			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))

I'm not sure what the is_fixup() is for, if the command is a fixup then it will have been preceded by a pick or merge so insert will already be 1

I feel a bit mean suggesting a reroll when we're on v7 already but I think these clean-ups would improve the maintainability of the code. I'll take a look at the rest of the changes to this series sometime this week.

Best Wishes

Phillip

Quoted 90 lines
sequencer.c +37 -10
+			insert = 1;
 	}
 
 	/* insert or append final <commands> */
-	if (insert >= 0 && insert < todo_list.nr)
-		strbuf_insert(buf, todo_list.items[insert].offset_in_buf +
-			      offset, commands, commands_len);
-	else if (insert >= 0 || !offset)
-		strbuf_add(buf, commands, commands_len);
+	if (insert || nr == todo_list->nr) {
+		ALLOC_GROW(items, nr + commands->nr, alloc);
+		COPY_ARRAY(items + nr, base_items, commands->nr);
+		nr += commands->nr;
+	}
+
+	free(base_items);
+	FREE_AND_NULL(todo_list->items);
+	todo_list->items = items;
+	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)
+{
+	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);
+	}
+
+	todo_list_add_exec_commands(&todo_list, commands);
+	res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1, 0);
 	todo_list_release(&todo_list);
-	return i;
+
+	if (res)
+		return error_errno(_("could not write '%s'."), todo_file);
+	return 0;
 }
 
 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
@@ -4790,7 +4817,7 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash)
 {
 	const char *shortonto, *todo_file = rebase_path_todo();
@@ -4809,8 +4836,8 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	if (autosquash && rearrange_squash(r))
 		return -1;
 
-	if (cmd && *cmd)
-		sequencer_add_exec_commands(r, cmd);
+	if (commands->nr)
+		sequencer_add_exec_commands(r, commands);
 
 	if (strbuf_read_file(buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
sequencer.h +3 -2
index 217353e9f0..87d04a3b9b 100644
@@ -146,12 +146,13 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 			  const char **argv,
 			  unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r, const char *command);
+int sequencer_add_exec_commands(struct repository *r,
+				struct string_list *commands);
 int transform_todo_file(struct repository *r, unsigned flags);
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
 int rearrange_squash(struct repository *r);
 
#156 lore raw

Re: [PATCH v7 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

Hi Phillip,

Le 12/02/2019 à 11:52, Phillip Wood a écrit :

Quoted 54 lines

Hi Alban

I think this is almost there, I've got a couple of small comments below.

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 226

Quoted 12 lines · Alban Gruin

-%<-

builtin/rebase--interactive.c +2 -1
index df19ccaeb9..c131fd4a27 100644
-%<-
@@ -221,6 +222,11 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);

I'd suggest a comment along the lines of
/* As cmd always ends with a newline the last item is empty */

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 227

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+		--commands.nr;

Style: commands.nr--

Quoted 15 lines
builtin/rebase--interactive.c +3 -1
+	}
+
 	switch (command) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +234,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 275

Quoted 9 lines
builtin/rebase--interactive.c +1 -1
@@ -262,11 +268,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
 	}

Before freeing the string list it would be good to reset the number of items with commands.nr++ (with a comment explaining why) so the NUL in the last item gets freed.

Quoted 6 lines

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 277

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+	string_list_clear(&commands, 1);

As we don't use item.util I think the second argument would be better as 0.

Quoted 2 lines
builtin/rebase--interactive.c +0 -0
 	return !!ret;
 }

FWIW I just stumbled across string_list_remove_empty_items(), which seems to do exactly the same thing, but that way we don’t have to do this kind of hacks.

Quoted 69 lines
Quoted 55 lines
sequencer.c +18 -19
index 99e12c751e..82ca3432cd 100644
@@ -4505,21 +4505,27 @@ int sequencer_make_script(struct repository *r, FILE *out,
  * Add commands after pick and (series of) squash/fixup commands
  * in the todo list.
  */
-int sequencer_add_exec_commands(struct repository *r,
-				const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+					struct string_list *commands)
 {
-	const char *todo_file = rebase_path_todo();
-	struct todo_list todo_list = TODO_LIST_INIT;
-	struct strbuf *buf = &todo_list.buf;
-	size_t offset = 0, commands_len = strlen(commands);
-	int i, insert;
+	struct strbuf *buf = &todo_list->buf;
+	size_t base_offset = buf->len;
+	int i, insert, nr = 0, alloc = 0;
+	struct todo_item *items = NULL, *base_items = NULL;
 
-	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-		return error(_("could not read '%s'."), todo_file);
+	base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+	for (i = 0; i < commands->nr; i++) {
+		size_t command_len = strlen(commands->items[i].string);
 
-	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);
+		strbuf_addstr(buf, commands->items[i].string);
+		strbuf_addch(buf, '\n');
+
+		base_items[i].command = TODO_EXEC;
+		base_items[i].offset_in_buf = base_offset;
+		base_items[i].arg_offset = base_offset + strlen("exec ");
+		base_items[i].arg_len = command_len - strlen("exec ");
+
+		base_offset += command_len + 1;
 	}
 
 	/*
@@ -4527,39 +4533,60 @@ int sequencer_add_exec_commands(struct repository *r,
 	 * are considered part of the pick, so we insert the commands *after*
 	 * those chains if there are any.
 	 */
-	insert = -1;
-	for (i = 0; i < todo_list.nr; i++) {
-		enum todo_command command = todo_list.items[i].command;
-
-		if (insert >= 0) {
-			/* skip fixup/squash chains */
-			if (command == TODO_COMMENT)

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4546

Quoted 10 lines
sequencer.c +0 -10
-				continue;
-			else if (is_fixup(command)) {
-				insert = i + 1;
-				continue;
-			}
-			strbuf_insert(buf,
-				      todo_list.items[insert].offset_in_buf +
-				      offset, commands, commands_len);
-			offset += commands_len;
-			insert = -1;

I like the simplification of using insert as a flag. Perhaps we should document the assumptions. Maybe something like

Quoted 7 lines

We insert the exec commands immediately after rearranging any fixups and before the user edits the list. This means that a fixup chain can never contain comments (any comments are empty picks that have been commented out the the user did not specify --keep-empty) and so it is safe to insert the exec command without looking at the command following the comment.

I slightly reworded this and added it to the existing comment just before the for loop:

/*
* 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.
*/

Quoted 21 lines
Quoted 7 lines
sequencer.c +7 -0
+	insert = 0;
+	for (i = 0; i < todo_list->nr; i++) {
+		enum todo_command command = todo_list->items[i].command;
+		if (insert && !is_fixup(command)) {
+			ALLOC_GROW(items, nr + commands->nr, alloc);
+			COPY_ARRAY(items + nr, base_items, commands->nr);
+			nr += commands->nr;

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4550

Quoted 10 lines
sequencer.c +6 -2
+
+			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))

I'm not sure what the is_fixup() is for, if the command is a fixup then it will have been preceded by a pick or merge so insert will already be 1

Quoted 9 lines

I feel a bit mean suggesting a reroll when we're on v7 already but I think these clean-ups would improve the maintainability of the code. I'll take a look at the rest of the changes to this series sometime this week.

Best Wishes

Phillip

Cheers,
Alban

#157 lore raw

Re: [PATCH v7 07/16] sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

Hi Alban

Quoted 61 lines · Alban Gruin

Hi Phillip,

Le 12/02/2019 à 11:52, Phillip Wood a écrit :

Quoted 58 lines

Hi Alban

I think this is almost there, I've got a couple of small comments below.

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 226

Quoted 12 lines · Alban Gruin

-%<-

builtin/rebase--interactive.c +2 -1
index df19ccaeb9..c131fd4a27 100644
-%<-
@@ -221,6 +222,11 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);

I'd suggest a comment along the lines of
/* As cmd always ends with a newline the last item is empty */

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 227

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+		--commands.nr;

Style: commands.nr--

Quoted 15 lines
builtin/rebase--interactive.c +3 -1
+	}
+
 	switch (command) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +234,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 275

Quoted 9 lines
builtin/rebase--interactive.c +1 -1
@@ -262,11 +268,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
 	}

Before freeing the string list it would be good to reset the number of items with commands.nr++ (with a comment explaining why) so the NUL in the last item gets freed.

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 277

Quoted 1 line
builtin/rebase--interactive.c +1 -0
+	string_list_clear(&commands, 1);

As we don't use item.util I think the second argument would be better as 0.

Quoted 6 lines
Quoted 2 lines

builtin/rebase--interactive.c int cmd_rebase__interactive(int argc, const char **argv, const char *prefix) · line 279

Quoted 2 lines
builtin/rebase--interactive.c +0 -0
 	return !!ret;
 }

FWIW I just stumbled across string_list_remove_empty_items(), which seems to do exactly the same thing, but that way we don’t have to do this kind of hacks.

Good find, that sounds like a much better solution.

Quoted 81 lines
Quoted 70 lines
Quoted 56 lines
sequencer.c +18 -19
index 99e12c751e..82ca3432cd 100644
@@ -4505,21 +4505,27 @@ int sequencer_make_script(struct repository *r, FILE *out,
  * Add commands after pick and (series of) squash/fixup commands
  * in the todo list.
  */
-int sequencer_add_exec_commands(struct repository *r,
-				const char *commands)
+static void todo_list_add_exec_commands(struct todo_list *todo_list,
+					struct string_list *commands)
 {
-	const char *todo_file = rebase_path_todo();
-	struct todo_list todo_list = TODO_LIST_INIT;
-	struct strbuf *buf = &todo_list.buf;
-	size_t offset = 0, commands_len = strlen(commands);
-	int i, insert;
+	struct strbuf *buf = &todo_list->buf;
+	size_t base_offset = buf->len;
+	int i, insert, nr = 0, alloc = 0;
+	struct todo_item *items = NULL, *base_items = NULL;
 
-	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
-		return error(_("could not read '%s'."), todo_file);
+	base_items = xcalloc(commands->nr, sizeof(struct todo_item));
+	for (i = 0; i < commands->nr; i++) {
+		size_t command_len = strlen(commands->items[i].string);
 
-	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);
+		strbuf_addstr(buf, commands->items[i].string);
+		strbuf_addch(buf, '\n');
+
+		base_items[i].command = TODO_EXEC;
+		base_items[i].offset_in_buf = base_offset;
+		base_items[i].arg_offset = base_offset + strlen("exec ");
+		base_items[i].arg_len = command_len - strlen("exec ");
+
+		base_offset += command_len + 1;
 	}
 
 	/*
@@ -4527,39 +4533,60 @@ int sequencer_add_exec_commands(struct repository *r,
 	 * are considered part of the pick, so we insert the commands *after*
 	 * those chains if there are any.
 	 */
-	insert = -1;
-	for (i = 0; i < todo_list.nr; i++) {
-		enum todo_command command = todo_list.items[i].command;
-
-		if (insert >= 0) {
-			/* skip fixup/squash chains */
-			if (command == TODO_COMMENT)

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4546

Quoted 10 lines
sequencer.c +0 -10
-				continue;
-			else if (is_fixup(command)) {
-				insert = i + 1;
-				continue;
-			}
-			strbuf_insert(buf,
-				      todo_list.items[insert].offset_in_buf +
-				      offset, commands, commands_len);
-			offset += commands_len;
-			insert = -1;

I like the simplification of using insert as a flag. Perhaps we should document the assumptions. Maybe something like

Quoted 7 lines

We insert the exec commands immediately after rearranging any fixups and before the user edits the list. This means that a fixup chain can never contain comments (any comments are empty picks that have been commented out the the user did not specify --keep-empty) and so it is safe to insert the exec command without looking at the command following the comment.

I slightly reworded this and added it to the existing comment just before the for loop:

Quoted 13 lines

/*
* 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.
*/

That sounds good

Best Wishes

Phillip

Quoted 34 lines
Quoted 21 lines
Quoted 7 lines
sequencer.c +7 -0
+	insert = 0;
+	for (i = 0; i < todo_list->nr; i++) {
+		enum todo_command command = todo_list->items[i].command;
+		if (insert && !is_fixup(command)) {
+			ALLOC_GROW(items, nr + commands->nr, alloc);
+			COPY_ARRAY(items + nr, base_items, commands->nr);
+			nr += commands->nr;

sequencer.c int sequencer_add_exec_commands(struct repository *r, · line 4550

Quoted 10 lines
sequencer.c +6 -2
+
+			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))

I'm not sure what the is_fixup() is for, if the command is a fixup then it will have been preceded by a pick or merge so insert will already be 1

Quoted 9 lines

I feel a bit mean suggesting a reroll when we're on v7 already but I think these clean-ups would improve the maintainability of the code. I'll take a look at the rest of the changes to this series sometime this week.

Best Wishes

Phillip

Cheers,
Alban

#158 lore raw

PATCH v7 8/16 sequencer: refactor rearrange_squash() to work on a todo_list

In reply to Alban Gruin

This refactors rearrange_squash() to work on a todo_list to avoid redundant reads and writes. The function is renamed todo_list_rearrange_squash().

The old version created a new buffer, which was directly written to the disk. This new version creates a new item list by just copying items from the old item list, without creating a new buffer. This eliminates the need to reparse the todo list, but this also means its buffer cannot be directly written to the disk.

As rebase -p still need to check the todo list from the disk, a new function is introduced, rearrange_squash_in_todo_file().

complete_action() still uses rearrange_squash_in_todo_file() for now. This will be changed in a future commit.

---
No changes since v6.

 builtin/rebase--interactive.c |  2 +-
 sequencer.c                   | 92 ++++++++++++++++++-----------------
 sequencer.h                   |  2 +-
 3 files changed, 49 insertions(+), 47 deletions(-)
builtin/rebase--interactive.c +1 -1
index c131fd4a27..74ebe7a10e 100644
@@ -265,7 +265,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = check_todo_list_from_file(the_repository);
 		break;
 	case REARRANGE_SQUASH:
-		ret = rearrange_squash(the_repository);
+		ret = rearrange_squash_in_todo_file(the_repository);
 		break;
 	case ADD_EXEC:
 		ret = sequencer_add_exec_commands(the_repository, &commands);
sequencer.c +47 -45

156 lines not on this page · raw message

sequencer.h +1 -1
index 87d04a3b9b..add50f04f1 100644
@@ -154,7 +154,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		    const char *shortrevisions, const char *onto_name,
 		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
-int rearrange_squash(struct repository *r);
+int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
 
Signature · 1 line
2.20.1
#159 lore raw

PATCH v7 9/16 sequencer: make sequencer_make_script() write its script to a strbuf

In reply to Alban Gruin

This makes sequencer_make_script() write its script to a strbuf (ie. the buffer of a todo_list) instead of a FILE. This reduce the amount of read/write made by rebase interactive.

---
No changes since v6.

 builtin/rebase--interactive.c | 13 ++++++-----
 sequencer.c                   | 41 +++++++++++++++--------------------
 sequencer.h                   |  5 ++---
 3 files changed, 28 insertions(+), 31 deletions(-)
builtin/rebase--interactive.c +8 -5
index 74ebe7a10e..506154b5e2 100644
@@ -71,7 +71,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list;
+	FILE *todo_list_file;
+	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
 		return -1;
@@ -93,8 +94,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list = fopen(rebase_path_todo(), "w");
-	if (!todo_list) {
+	todo_list_file = fopen(rebase_path_todo(), "w");
+	if (!todo_list_file) {
 		free(revisions);
 		free(shortrevisions);
 
@@ -105,10 +106,11 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
 
-	ret = sequencer_make_script(the_repository, todo_list,
+	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fclose(todo_list);
+	fputs(todo_list.buf.buf, todo_list_file);
+	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
@@ -121,6 +123,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 
 	free(revisions);
 	free(shortrevisions);
+	todo_list_release(&todo_list);
 	argv_array_clear(&make_script_args);
 
 	return ret;
sequencer.c +18 -23

101 lines not on this page · raw message

sequencer.h +2 -3
index add50f04f1..e25f5151d3 100644
@@ -142,9 +142,8 @@ int sequencer_remove_state(struct replay_opts *opts);
 #define TODO_LIST_REBASE_COUSINS (1U << 4)
 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
 
-int sequencer_make_script(struct repository *r, FILE *out, int argc,
-			  const char **argv,
-			  unsigned flags);
+int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
+			  const char **argv, unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r,
 				struct string_list *commands);
Signature · 1 line
2.20.1
#160 lore raw

PATCH v7 10/16 sequencer: change complete_action() to use the refactored functions

In reply to Alban Gruin

complete_action() used functions that read the todo-list file, made some changes to it, and wrote it back to the disk.

The previous commits were dedicated to separate the part that deals with the file from the actual logic of these functions. Now that this is done, we can call directly the "logic" functions to avoid useless file access.

The parsing of the list has to be done by the caller. If the buffer of the todo list provided by the caller is empty, a `noop' command is directly added to the todo list, without touching the buffer.

---
 builtin/rebase--interactive.c | 20 +++------
 sequencer.c                   | 79 +++++++++++++++--------------------
 sequencer.h                   |  2 +-
 3 files changed, 41 insertions(+), 60 deletions(-)
builtin/rebase--interactive.c +6 -14
index 506154b5e2..4f2949922f 100644
@@ -71,7 +71,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list_file;
 	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
@@ -94,14 +93,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list_file = fopen(rebase_path_todo(), "w");
-	if (!todo_list_file) {
-		free(revisions);
-		free(shortrevisions);
-
-		return error_errno(_("could not open %s"), rebase_path_todo());
-	}
-
 	argv_array_pushl(&make_script_args, "", revisions, NULL);
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
@@ -109,16 +100,17 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fputs(todo_list.buf.buf, todo_list_file);
-	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
 	else {
 		discard_cache();
-		ret = complete_action(the_repository, opts, flags,
-				      shortrevisions, onto_name, onto,
-				      head_hash, commands, autosquash);
+		if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
+						&todo_list))
+			BUG("unusable todo list");
+
+		ret = complete_action(the_repository, opts, flags, shortrevisions, onto_name,
+				      onto, head_hash, commands, autosquash, &todo_list);
 	}
 
 	free(revisions);
sequencer.c +34 -45

127 lines not on this page · raw message

sequencer.h +1 -1
index e25f5151d3..7029b39cd6 100644
@@ -152,7 +152,7 @@ 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);
+		    unsigned autosquash, struct todo_list *todo_list);
 int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
Signature · 1 line
2.20.1
#161 lore raw

PATCH v7 11/16 sequencer: refactor skip_unnecessary_picks() to work on a todo_list

In reply to Alban Gruin

This refactors skip_unnecessary_picks() to work on a todo_list. As this function is only called by complete_action() (and thus is not used by rebase -p), the file-handling logic is completely dropped here.

Instead of truncating the todo list’s buffer, the items are moved to the beginning of the list, eliminating the need to reparse the list. This also means its buffer cannot be directly written to the disk.

rewrite_file() is then removed, as it is now unused.

---
 sequencer.c | 82 +++++++++++++----------------------------------------
 1 file changed, 19 insertions(+), 63 deletions(-)
sequencer.c +19 -63
index eb8a622af0..eacaf52250 100644
@@ -4717,52 +4717,22 @@ int check_todo_list_from_file(struct repository *r)
 	return res;
 }
 
-static int rewrite_file(const char *path, const char *buf, size_t len)
-{
-	int rc = 0;
-	int fd = open(path, O_WRONLY | O_TRUNC);
-	if (fd < 0)
-		return error_errno(_("could not open '%s' for writing"), path);
-	if (write_in_full(fd, buf, len) < 0)
-		rc = error_errno(_("could not write to '%s'"), path);
-	if (close(fd) && !rc)
-		rc = error_errno(_("could not close '%s'"), path);
-	return rc;
-}
-
 /* skip picking commits whose parents are unchanged */
-static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
+static int skip_unnecessary_picks(struct repository *r,
+				  struct todo_list *todo_list,
+				  struct object_id *base_oid)
 {
-	const char *todo_file = rebase_path_todo();
-	struct strbuf buf = STRBUF_INIT;
-	struct todo_list todo_list = TODO_LIST_INIT;
 	struct object_id *parent_oid;
-	int fd, i;
-
-	if (!read_oneliner(&buf, rebase_path_onto(), 0))
-		return error(_("could not read 'onto'"));
-	if (get_oid(buf.buf, output_oid)) {
-		strbuf_release(&buf);
-		return error(_("need a HEAD to fixup"));
-	}
-	strbuf_release(&buf);
-
-	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;
-	}
+	int i;
 
-	for (i = 0; i < todo_list.nr; i++) {
-		struct todo_item *item = todo_list.items + i;
+	for (i = 0; i < todo_list->nr; i++) {
+		struct todo_item *item = todo_list->items + i;
 
 		if (item->command >= TODO_NOOP)
 			continue;
 		if (item->command != TODO_PICK)
 			break;
 		if (parse_commit(item->commit)) {
-			todo_list_release(&todo_list);
 			return error(_("could not parse commit '%s'"),
 				oid_to_hex(&item->commit->object.oid));
 		}
@@ -4771,42 +4741,26 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 		if (item->commit->parents->next)
 			break; /* merge commit */
 		parent_oid = &item->commit->parents->item->object.oid;
-		if (!oideq(parent_oid, output_oid))
+		if (!oideq(parent_oid, base_oid))
 			break;
-		oidcpy(output_oid, &item->commit->object.oid);
+		oidcpy(base_oid, &item->commit->object.oid);
 	}
 	if (i > 0) {
-		int offset = get_item_line_offset(&todo_list, i);
 		const char *done_path = rebase_path_done();
 
-		fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
-		if (fd < 0) {
-			error_errno(_("could not open '%s' for writing"),
-				    done_path);
-			todo_list_release(&todo_list);
-			return -1;
-		}
-		if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
+		if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
 			error_errno(_("could not write to '%s'"), done_path);
-			todo_list_release(&todo_list);
-			close(fd);
 			return -1;
 		}
-		close(fd);
 
-		if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
-				 todo_list.buf.len - offset) < 0) {
-			todo_list_release(&todo_list);
-			return -1;
-		}
+		MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
+		todo_list->nr -= i;
+		todo_list->current = 0;
 
-		todo_list.current = i;
-		if (is_fixup(peek_command(&todo_list, 0)))
-			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
+		if (is_fixup(peek_command(todo_list, 0)))
+			record_in_rewritten(base_oid, peek_command(todo_list, 0));
 	}
 
-	todo_list_release(&todo_list);
-
 	return 0;
 }
 
@@ -4879,6 +4833,11 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return -1;
 	}
 
+	if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
+		todo_list_release(&new_todo);
+		return error(_("could not skip unnecessary pick commands"));
+	}
+
 	if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
 				    flags & ~(TODO_LIST_SHORTEN_IDS))) {
 		todo_list_release(&new_todo);
@@ -4887,9 +4846,6 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 
 	todo_list_release(&new_todo);
 
-	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
-		return error(_("could not skip unnecessary pick commands"));
-
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
 
Signature · 1 line
2.20.1
#162 lore raw

Re: [PATCH v7 11/16] sequencer: refactor skip_unnecessary_picks() to work on a todo_list

Hi Alban

Quoted 31 lines · Alban Gruin

This refactors skip_unnecessary_picks() to work on a todo_list. As this function is only called by complete_action() (and thus is not used by rebase -p), the file-handling logic is completely dropped here.

Instead of truncating the todo list’s buffer, the items are moved to the beginning of the list, eliminating the need to reparse the list. This also means its buffer cannot be directly written to the disk.

rewrite_file() is then removed, as it is now unused.

---
 sequencer.c | 82 +++++++++++++----------------------------------------
 1 file changed, 19 insertions(+), 63 deletions(-)
sequencer.c +0 -8
index eb8a622af0..eacaf52250 100644
@@ -4717,52 +4717,22 @@ int check_todo_list_from_file(struct repository *r)
 	return res;
 }
 
-static int rewrite_file(const char *path, const char *buf, size_t len)
-{
-	int rc = 0;
-	int fd = open(path, O_WRONLY | O_TRUNC);
-	if (fd < 0)
-		return error_errno(_("could not open '%s' for writing"), path);
-	if (write_in_full(fd, buf, len) < 0)
-		rc = error_errno(_("could not write to '%s'"), path);

sequencer.c int check_todo_list_from_file(struct repository *r) · line 4723

Quoted 10 lines
sequencer.c +3 -6
-	if (close(fd) && !rc)
-		rc = error_errno(_("could not close '%s'"), path);
-	return rc;
-}
-
 /* skip picking commits whose parents are unchanged */
-static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
+static int skip_unnecessary_picks(struct repository *r,
+				  struct todo_list *todo_list,
+				  struct object_id *base_oid)

Thanks for renaming that parameter, I think it's much clearer.

Best Wishes

Phillip

Quoted 111 lines
sequencer.c +16 -49
 {
-	const char *todo_file = rebase_path_todo();
-	struct strbuf buf = STRBUF_INIT;
-	struct todo_list todo_list = TODO_LIST_INIT;
 	struct object_id *parent_oid;
-	int fd, i;
-
-	if (!read_oneliner(&buf, rebase_path_onto(), 0))
-		return error(_("could not read 'onto'"));
-	if (get_oid(buf.buf, output_oid)) {
-		strbuf_release(&buf);
-		return error(_("need a HEAD to fixup"));
-	}
-	strbuf_release(&buf);
-
-	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;
-	}
+	int i;
 
-	for (i = 0; i < todo_list.nr; i++) {
-		struct todo_item *item = todo_list.items + i;
+	for (i = 0; i < todo_list->nr; i++) {
+		struct todo_item *item = todo_list->items + i;
 
 		if (item->command >= TODO_NOOP)
 			continue;
 		if (item->command != TODO_PICK)
 			break;
 		if (parse_commit(item->commit)) {
-			todo_list_release(&todo_list);
 			return error(_("could not parse commit '%s'"),
 				oid_to_hex(&item->commit->object.oid));
 		}
@@ -4771,42 +4741,26 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 		if (item->commit->parents->next)
 			break; /* merge commit */
 		parent_oid = &item->commit->parents->item->object.oid;
-		if (!oideq(parent_oid, output_oid))
+		if (!oideq(parent_oid, base_oid))
 			break;
-		oidcpy(output_oid, &item->commit->object.oid);
+		oidcpy(base_oid, &item->commit->object.oid);
 	}
 	if (i > 0) {
-		int offset = get_item_line_offset(&todo_list, i);
 		const char *done_path = rebase_path_done();
 
-		fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
-		if (fd < 0) {
-			error_errno(_("could not open '%s' for writing"),
-				    done_path);
-			todo_list_release(&todo_list);
-			return -1;
-		}
-		if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
+		if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
 			error_errno(_("could not write to '%s'"), done_path);
-			todo_list_release(&todo_list);
-			close(fd);
 			return -1;
 		}
-		close(fd);
 
-		if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
-				 todo_list.buf.len - offset) < 0) {
-			todo_list_release(&todo_list);
-			return -1;
-		}
+		MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
+		todo_list->nr -= i;
+		todo_list->current = 0;
 
-		todo_list.current = i;
-		if (is_fixup(peek_command(&todo_list, 0)))
-			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
+		if (is_fixup(peek_command(todo_list, 0)))
+			record_in_rewritten(base_oid, peek_command(todo_list, 0));
 	}
 
-	todo_list_release(&todo_list);
-
 	return 0;
 }
 
@@ -4879,6 +4833,11 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return -1;
 	}
 
+	if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
+		todo_list_release(&new_todo);
+		return error(_("could not skip unnecessary pick commands"));
+	}
+
 	if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
 				    flags & ~(TODO_LIST_SHORTEN_IDS))) {
 		todo_list_release(&new_todo);
@@ -4887,9 +4846,6 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 
 	todo_list_release(&new_todo);
 
-	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
-		return error(_("could not skip unnecessary pick commands"));
-
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
 
#163 lore raw

PATCH v7 12/16 rebase-interactive: use todo_list_write_to_file() in edit_todo_list()

In reply to Alban Gruin

Just like complete_action(), edit_todo_list() used a function (transform_todo_file()) that read the todo list from the disk and wrote it back, resulting in useless disk accesses.

This changes edit_todo_list() to call directly todo_list_write_to_file() instead.

---
No changes since v6.

 rebase-interactive.c | 38 ++++++++++++++++----------------------
 sequencer.c          |  4 ++--
 sequencer.h          |  3 ---
 3 files changed, 18 insertions(+), 27 deletions(-)
rebase-interactive.c +16 -22
index dfa6dd530f..d396ecc599 100644
@@ -79,39 +79,33 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 
 int edit_todo_list(struct repository *r, unsigned flags)
 {
-	struct strbuf buf = STRBUF_INIT;
 	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT;
+	int res = 0;
 
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
+	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
 
-	strbuf_stripspace(&buf, 1);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_stripspace(&todo_list.buf, 1);
+	todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+	if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
-
-	transform_todo_file(r, flags | TODO_LIST_SHORTEN_IDS);
-
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
-		return error_errno(_("could not read '%s'."), todo_file);
-
-	append_todo_help(1, 0, &buf);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_reset(&todo_list.buf);
+	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
+	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
+		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+					      flags & ~(TODO_LIST_SHORTEN_IDS));
 
-	if (launch_sequence_editor(todo_file, NULL, NULL))
-		return -1;
-
-	transform_todo_file(r, flags & ~(TODO_LIST_SHORTEN_IDS));
-
-	return 0;
+	todo_list_release(&todo_list);
+	return res;
 }
 
 define_commit_slab(commit_seen, unsigned char);
sequencer.c +2 -2
index eacaf52250..74fbb14153 100644
@@ -383,8 +383,8 @@ static void print_advice(struct repository *r, int show_hint,
 	}
 }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol)
+static int write_message(const void *buf, size_t len, const char *filename,
+			 int append_eol)
 {
 	struct lock_file msg_file = LOCK_INIT;
 
sequencer.h +0 -3
index 7029b39cd6..c80990659c 100644
@@ -64,9 +64,6 @@ struct replay_opts {
 };
 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol);
-
 /*
  * Note that ordering matters in this enum. Not only must it match the mapping
  * of todo_command_info (in sequencer.c), it is also divided into several
Signature · 1 line
2.20.1
#164 lore raw

PATCH v7 13/16 rebase-interactive: append_todo_help() changes

In reply to Alban Gruin

This moves the writing of the comment "Rebase $shortrevisions onto $shortonto ($command_count commands)" from todo_list_write_to_file() to append_todo_help().

shortrevisions, shortonto, and command_count are passed as parameters to append_todo_help().

During the initial edit of the todo list, shortrevisions and shortonto are not NULL. Therefore, if shortrevisions or shortonto is NULL, then edit_todo would be true, otherwise it would be false. Thus, edit_todo is removed from the parameters of append_todo_help().

---
No changes since v6.

 rebase-interactive.c | 12 +++++++++++-
 rebase-interactive.h |  3 ++-
 sequencer.c          | 17 ++++-------------
 3 files changed, 17 insertions(+), 15 deletions(-)
rebase-interactive.c +11 -1
index d396ecc599..807f8370db 100644
@@ -28,7 +28,8 @@ static enum missing_commit_check_level get_missing_commit_check_level(void)
 	return MISSING_COMMIT_CHECK_IGNORE;
 }
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf)
 {
 	const char *msg = _("\nCommands:\n"
@@ -48,6 +49,15 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 ".       specified). Use -c <commit> to reword the commit message.\n"
 "\n"
 "These lines can be re-ordered; they are executed from top to bottom.\n");
+	unsigned edit_todo = !(shortrevisions && shortonto);
+
+	if (!edit_todo) {
+		strbuf_addch(buf, '\n');
+		strbuf_commented_addf(buf, Q_("Rebase %s onto %s (%d command)",
+					      "Rebase %s onto %s (%d commands)",
+					      command_count),
+				      shortrevisions, shortonto, command_count);
+	}
 
 	strbuf_add_commented_lines(buf, msg, strlen(msg));
 
rebase-interactive.h +2 -1
index 187b5032d6..0e5925e3aa 100644
@@ -5,7 +5,8 @@ struct strbuf;
 struct repository;
 struct todo_list;
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
 int edit_todo_list(struct repository *r, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
sequencer.c +4 -13
index 74fbb14153..64d698032c 100644
@@ -4636,22 +4636,13 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 			    const char *file, const char *shortrevisions,
 			    const char *shortonto, int num, unsigned flags)
 {
-	int edit_todo = !(shortrevisions && shortonto), res;
+	int res;
 	struct strbuf buf = STRBUF_INIT;
 
 	todo_list_to_strbuf(r, todo_list, &buf, num, flags);
-
-	if (flags & TODO_LIST_APPEND_TODO_HELP) {
-		int command_count = count_commands(todo_list);
-		if (!edit_todo) {
-			strbuf_addch(&buf, '\n');
-			strbuf_commented_addf(&buf, Q_("Rebase %s onto %s (%d command)",
-						       "Rebase %s onto %s (%d commands)",
-						       command_count),
-					      shortrevisions, shortonto, command_count);
-		}
-		append_todo_help(edit_todo, flags & TODO_LIST_KEEP_EMPTY, &buf);
-	}
+	if (flags & TODO_LIST_APPEND_TODO_HELP)
+		append_todo_help(flags & TODO_LIST_KEEP_EMPTY, count_commands(todo_list),
+				 shortrevisions, shortonto, &buf);
 
 	res = write_message(buf.buf, buf.len, file, 0);
 	strbuf_release(&buf);
Signature · 1 line
2.20.1
#165 lore raw

PATCH v7 14/16 rebase-interactive: rewrite edit_todo_list() to handle the initial edit

In reply to Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
 builtin/rebase--interactive.c | 24 +++++++++++++++++-
 rebase-interactive.c          | 48 +++++++++++++++++------------------
 rebase-interactive.h          |  4 ++-
 sequencer.c                   |  3 +--
 sequencer.h                   |  1 +
 5 files changed, 52 insertions(+), 28 deletions(-)
builtin/rebase--interactive.c +23 -1
index 4f2949922f..370d584683 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int edit_todo_file(unsigned flags)
+{
+	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT,
+		new_todo = 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);
+
+	strbuf_stripspace(&todo_list.buf, 1);
+	res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
+	if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
+					    NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
+		res = error_errno(_("could not write '%s'"), todo_file);
+
+	todo_list_release(&todo_list);
+	todo_list_release(&new_todo);
+
+	return res;
+}
+
 static int get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -241,7 +263,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		break;
 	}
 	case EDIT_TODO:
-		ret = edit_todo_list(the_repository, flags);
+		ret = edit_todo_file(flags);
 		break;
 	case SHOW_CURRENT_PATCH: {
 		struct child_process cmd = CHILD_PROCESS_INIT;
rebase-interactive.c +24 -24

59 lines not on this page · raw message

rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
 void append_todo_help(unsigned keep_empty, int command_count,
 		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +1 -2
index 64d698032c..f6ed4e21e9 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  * file and written to the tail of 'done'.
  */
 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-		     "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
 
 /*
  * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index c80990659c..b0688ba2a1 100644
@@ -10,6 +10,7 @@ struct repository;
 const char *git_path_commit_editmsg(void);
 const char *git_path_seq_dir(void);
 const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
 
 #define APPEND_SIGNOFF_DEDUP (1u << 0)
 
Signature · 1 line
2.20.1
#166 lore raw

Re: [PATCH v7 14/16] rebase-interactive: rewrite edit_todo_list() to handle the initial edit

Hi Alban

I think the error handling is fine now, I've got a couple of small comments below.

Quoted 85 lines · Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
 builtin/rebase--interactive.c | 24 +++++++++++++++++-
 rebase-interactive.c          | 48 +++++++++++++++++------------------
 rebase-interactive.h          |  4 ++-
 sequencer.c                   |  3 +--
 sequencer.h                   |  1 +
 5 files changed, 52 insertions(+), 28 deletions(-)
builtin/rebase--interactive.c +23 -1
index 4f2949922f..370d584683 100644
@@ -13,6 +13,28 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int edit_todo_file(unsigned flags)
+{
+	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT,
+		new_todo = 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);
+
+	strbuf_stripspace(&todo_list.buf, 1);
+	res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
+	if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
+					    NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
+		res = error_errno(_("could not write '%s'"), todo_file);
+
+	todo_list_release(&todo_list);
+	todo_list_release(&new_todo);
+
+	return res;
+}
+
 static int get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -241,7 +263,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		break;
 	}
 	case EDIT_TODO:
-		ret = edit_todo_list(the_repository, flags);
+		ret = edit_todo_file(flags);
 		break;
 	case SHOW_CURRENT_PATCH: {
 		struct child_process cmd = CHILD_PROCESS_INIT;
rebase-interactive.c +3 -13
index 807f8370db..96c70d1959 100644
@@ -87,35 +87,35 @@ void append_todo_help(unsigned keep_empty, int command_count,
 	}
 }
 
-int edit_todo_list(struct repository *r, unsigned flags)
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags)
 {
 	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);
-
-	strbuf_stripspace(&todo_list.buf, 1);
-	todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
-	if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
-				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
-		todo_list_release(&todo_list);
-		return -1;

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count, · line 98

Quoted 10 lines
rebase-interactive.c +3 -6
-	}
+	unsigned initial = shortrevisions && shortonto;
 
-	strbuf_reset(&todo_list.buf);
-	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
-		todo_list_release(&todo_list);
-		return -1;
-	}
+	if (!initial)
+		todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);

It might be worth a comment to explain that we always want to edit the file so we deliberately ignore any parsing errors (I'm not sure what we end writing to the disc if we can't parse the file though) and that the todo list is already parsed in the initial case.

Quoted 13 lines
rebase-interactive.c +6 -5
-	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
-		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
-					      flags & ~(TODO_LIST_SHORTEN_IDS));
+	if (todo_list_write_to_file(r, todo_list, todo_file, shortrevisions, shortonto,
+				    -1, flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
+		return error_errno(_("could not write '%s'"), todo_file);
 
-	todo_list_release(&todo_list);
-	return res;
+	if (initial && copy_file(rebase_path_todo_backup(), todo_file, 0666))
+		return error(_("could not copy '%s' to '%s'."), todo_file,
+			     rebase_path_todo_backup());

rebase-interactive.c void append_todo_help(unsigned keep_empty, int command_count, · line 116

Quoted 10 lines
rebase-interactive.c +10 -0
+
+	if (launch_sequence_editor(todo_file, &new_todo->buf, NULL))
+		return -2;
+
+	strbuf_stripspace(&new_todo->buf, 1);
+	if (initial && new_todo->buf.len == 0)
+		return -3;
+
+	if (!initial)
+		return todo_list_parse_insn_buffer(r, new_todo->buf.buf, new_todo);

It might be worth a comment explaining where the list gets parsed for the initial edit.

Best Wishes

Phillip

Quoted 47 lines
rebase-interactive.c +2 -0
+
+	return 0;
 }
 
 define_commit_slab(commit_seen, unsigned char);
rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
 void append_todo_help(unsigned keep_empty, int command_count,
 		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +1 -2
index 64d698032c..f6ed4e21e9 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  * file and written to the tail of 'done'.
  */
 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-		     "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
 
 /*
  * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index c80990659c..b0688ba2a1 100644
@@ -10,6 +10,7 @@ struct repository;
 const char *git_path_commit_editmsg(void);
 const char *git_path_seq_dir(void);
 const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
 
 #define APPEND_SIGNOFF_DEDUP (1u << 0)
 
#167 lore raw

PATCH v7 15/16 sequencer: use edit_todo_list() in complete_action()

In reply to Alban Gruin

This changes complete_action() to use edit_todo_list(), now that it can handle the initial edit of the todo list.

---
No changes since v6.

 sequencer.c | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)
sequencer.c +7 -14
index f6ed4e21e9..df8b239fdc 100644
@@ -4765,6 +4765,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	struct todo_list new_todo = TODO_LIST_INIT;
 	struct strbuf *buf = &todo_list->buf;
 	struct object_id oid;
+	int res;
 
 	get_oid(onto, &oid);
 	shortonto = find_unique_abbrev(&oid, DEFAULT_ABBREV);
@@ -4789,24 +4790,16 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return error(_("nothing to do"));
 	}
 
-	if (todo_list_write_to_file(r, todo_list, todo_file,
-				    shortrevisions, shortonto, -1,
-				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
-		return error_errno(_("could not write '%s'"), todo_file);
-
-	if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
-		return error(_("could not copy '%s' to '%s'."), todo_file,
-			     rebase_path_todo_backup());
-
-	if (launch_sequence_editor(todo_file, &new_todo.buf, NULL)) {
+	res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
+			     shortonto, flags);
+	if (res == -1)
+		return -1;
+	else if (res == -2) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 
 		return -1;
-	}
-
-	strbuf_stripspace(&new_todo.buf, 1);
-	if (new_todo.buf.len == 0) {
+	} else if (res == -3) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 		todo_list_release(&new_todo);
Signature · 1 line
2.20.1
#168 lore raw

PATCH v7 16/16 rebase--interactive: move several functions to rebase--interactive.c

In reply to Alban Gruin

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.

The parameter r (repository) is dropped from them, and the error handling of rearrange_squash_in_todo_file() is slightly improved.

---
 builtin/rebase--interactive.c | 81 +++++++++++++++++++++++++++++++++--
 sequencer.c                   | 79 ++--------------------------------
 sequencer.h                   |  7 ++-
 3 files changed, 84 insertions(+), 83 deletions(-)
builtin/rebase--interactive.c +78 -3
index 370d584683..fb11f23692 100644
@@ -13,6 +13,81 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int add_exec_commands(struct string_list *commands)
+{
+	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);
+	}
+
+	todo_list_add_exec_commands(&todo_list, commands);
+	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 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();
@@ -276,16 +351,16 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	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();
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, &commands);
+		ret = add_exec_commands(&commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
sequencer.c +3 -76

112 lines not on this page · raw message

sequencer.h +3 -4
index b0688ba2a1..7cca49eff2 100644
@@ -143,15 +143,14 @@ int sequencer_remove_state(struct replay_opts *opts);
 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 			  const char **argv, unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r,
-				struct string_list *commands);
-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[];
 
Signature · 1 line
2.20.1
#169 lore raw

Re: [PATCH v7 16/16] rebase--interactive: move several functions to rebase--interactive.c

Hi Alban

I think it is a good idea to move these functions out of sequencer.c, previously I suggested moving them to rebase-interactive.c rather than builtin/rebase--interactive.c but I don't think it matters that much. If these can be moved when they're refactored (or in a separate commit immediately after they're refactored if that makes the refactoring patch clearer) rather than at the end it might make the history cleaner.

Best Wishes

Phillip

Quoted 266 lines · Alban Gruin

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.

The parameter r (repository) is dropped from them, and the error handling of rearrange_squash_in_todo_file() is slightly improved.

---
 builtin/rebase--interactive.c | 81 +++++++++++++++++++++++++++++++++--
 sequencer.c                   | 79 ++--------------------------------
 sequencer.h                   |  7 ++-
 3 files changed, 84 insertions(+), 83 deletions(-)
builtin/rebase--interactive.c +78 -3
index 370d584683..fb11f23692 100644
@@ -13,6 +13,81 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int add_exec_commands(struct string_list *commands)
+{
+	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);
+	}
+
+	todo_list_add_exec_commands(&todo_list, commands);
+	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 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();
@@ -276,16 +351,16 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	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();
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, &commands);
+		ret = add_exec_commands(&commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
sequencer.c +3 -76
index df8b239fdc..7d35f83f4c 100644
@@ -4499,8 +4499,8 @@ int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
  * Add commands after pick and (series of) squash/fixup commands
  * in the todo list.
  */
-static void todo_list_add_exec_commands(struct todo_list *todo_list,
-					struct string_list *commands)
+void todo_list_add_exec_commands(struct todo_list *todo_list,
+				 struct string_list *commands)
 {
 	struct strbuf *buf = &todo_list->buf;
 	size_t base_offset = buf->len;
@@ -4559,30 +4559,6 @@ static void todo_list_add_exec_commands(struct todo_list *todo_list,
 	todo_list->alloc = alloc;
 }
 
-int sequencer_add_exec_commands(struct repository *r,
-				struct string_list *commands)
-{
-	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);
-	}
-
-	todo_list_add_exec_commands(&todo_list, commands);
-	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;
-}
-
 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
 				struct strbuf *buf, int num, unsigned flags)
 {
@@ -4649,29 +4625,6 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 	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"
@@ -4754,8 +4707,6 @@ static int skip_unnecessary_picks(struct repository *r,
 	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,
@@ -4862,7 +4813,7 @@ define_commit_slab(commit_todo_item, struct todo_item *);
  * 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;
@@ -5000,27 +4951,3 @@ static int todo_list_rearrange_squash(struct todo_list *todo_list)
 
 	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;
-}
sequencer.h +3 -4
index b0688ba2a1..7cca49eff2 100644
@@ -143,15 +143,14 @@ int sequencer_remove_state(struct replay_opts *opts);
 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 			  const char **argv, unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r,
-				struct string_list *commands);
-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[];
 
#170 lore raw

v8 cover sequencer: refactor functions working on a todo_list

In reply to Alban Gruin

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 <[email protected]>
     
    -    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 <[email protected]>
     
    @@ -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()
Signature · 1 line
2.20.1
#171 lore raw

PATCH v8 1/18 sequencer: changes in parse_insn_buffer()

This clears the number of items of a todo_list before parsing it to allow to parse the same list multiple times without issues. As its items are not dynamically allocated, or don’t need to allocate memory, no additionnal memory management is required here.

Furthermore, if a line is invalid, the type of the corresponding command is set to a garbage value, and its argument is defined properly. This will allow to recreate the text of a todo list from its commands, even if one of them is incorrect.

---
No changes since v7.

 sequencer.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
sequencer.c +6 -1
index b68bca0bef..d605199a54 100644
@@ -2141,6 +2141,8 @@ static int parse_insn_buffer(struct repository *r, char *buf,
 	char *p = buf, *next_p;
 	int i, res = 0, fixup_okay = file_exists(rebase_path_done());
 
+	todo_list->current = todo_list->nr = 0;
+
 	for (i = 1; *p; i++, p = next_p) {
 		char *eol = strchrnul(p, '\n');
 
@@ -2154,7 +2156,10 @@ static int parse_insn_buffer(struct repository *r, char *buf,
 		if (parse_insn_line(r, item, p, eol)) {
 			res = error(_("invalid line %d: %.*s"),
 				i, (int)(eol - p), p);
-			item->command = TODO_NOOP;
+			item->command = TODO_COMMENT + 1;
+			item->arg = p;
+			item->arg_len = (int)(eol - p);
+			item->commit = NULL;
 		}
 
 		if (fixup_okay)
Signature · 1 line
2.20.1
#172 lore raw

PATCH v8 2/18 sequencer: make the todo_list structure public

In reply to Alban Gruin

This makes the structures todo_list and todo_item, and the functions todo_list_release() and parse_insn_buffer(), accessible outside of sequencer.c.

---
No changes since v7.

 sequencer.c | 69 ++++++++++-------------------------------------------
 sequencer.h | 50 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 57 deletions(-)
sequencer.c +12 -57
index d605199a54..25cc7a9a91 100644
@@ -1510,32 +1510,6 @@ static int allow_empty(struct repository *r,
 		return 1;
 }
 
-/*
- * Note that ordering matters in this enum. Not only must it match the mapping
- * below, it is also divided into several sections that matter.  When adding
- * new commands, make sure you add it in the right section.
- */
-enum todo_command {
-	/* commands that handle commits */
-	TODO_PICK = 0,
-	TODO_REVERT,
-	TODO_EDIT,
-	TODO_REWORD,
-	TODO_FIXUP,
-	TODO_SQUASH,
-	/* commands that do something else than handling a single commit */
-	TODO_EXEC,
-	TODO_BREAK,
-	TODO_LABEL,
-	TODO_RESET,
-	TODO_MERGE,
-	/* commands that do nothing but are counted for reporting progress */
-	TODO_NOOP,
-	TODO_DROP,
-	/* comments (not counted for reporting progress) */
-	TODO_COMMENT
-};
-
 static struct {
 	char c;
 	const char *str;
@@ -2012,26 +1986,7 @@ enum todo_item_flags {
 	TODO_EDIT_MERGE_MSG = 1
 };
 
-struct todo_item {
-	enum todo_command command;
-	struct commit *commit;
-	unsigned int flags;
-	const char *arg;
-	int arg_len;
-	size_t offset_in_buf;
-};
-
-struct todo_list {
-	struct strbuf buf;
-	struct todo_item *items;
-	int nr, alloc, current;
-	int done_nr, total_nr;
-	struct stat_data stat;
-};
-
-#define TODO_LIST_INIT { STRBUF_INIT }
-
-static void todo_list_release(struct todo_list *todo_list)
+void todo_list_release(struct todo_list *todo_list)
 {
 	strbuf_release(&todo_list->buf);
 	FREE_AND_NULL(todo_list->items);
@@ -2134,8 +2089,8 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	return !item->commit;
 }
 
-static int parse_insn_buffer(struct repository *r, char *buf,
-			     struct todo_list *todo_list)
+int todo_list_parse_insn_buffer(struct repository *r, char *buf,
+				struct todo_list *todo_list)
 {
 	struct todo_item *item;
 	char *p = buf, *next_p;
@@ -2234,7 +2189,7 @@ static int read_populate_todo(struct repository *r,
 		return error(_("could not stat '%s'"), todo_file);
 	fill_stat_data(&todo_list->stat, &st);
 
-	res = parse_insn_buffer(r, todo_list->buf.buf, todo_list);
+	res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
 	if (res) {
 		if (is_rebase_i(opts))
 			return error(_("please fix this using "
@@ -2265,7 +2220,7 @@ static int read_populate_todo(struct repository *r,
 		FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
 
 		if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
-		    !parse_insn_buffer(r, done.buf.buf, &done))
+		    !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
 			todo_list->done_nr = count_commands(&done);
 		else
 			todo_list->done_nr = 0;
@@ -4556,7 +4511,7 @@ int sequencer_add_exec_commands(struct repository *r,
 	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
+	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);
 	}
@@ -4612,7 +4567,7 @@ int transform_todos(struct repository *r, unsigned flags)
 	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list)) {
+	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);
 	}
@@ -4698,7 +4653,7 @@ int check_todo_list(struct repository *r)
 		goto leave_check;
 	}
 	advise_to_edit_todo = res =
-		parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+		todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
 
 	if (res || check_level == MISSING_COMMIT_CHECK_IGNORE)
 		goto leave_check;
@@ -4717,7 +4672,7 @@ int check_todo_list(struct repository *r)
 		goto leave_check;
 	}
 	strbuf_release(&todo_file);
-	res = !!parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+	res = !!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
 
 	/* Find commits in git-rebase-todo.backup yet unseen */
 	for (i = todo_list.nr - 1; i >= 0; i--) {
@@ -4799,7 +4754,7 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 
 	if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
 		return -1;
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
+	if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
 		todo_list_release(&todo_list);
 		return -1;
 	}
@@ -4887,7 +4842,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	if (strbuf_read_file(buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
 
-	if (parse_insn_buffer(r, buf->buf, &todo_list)) {
+	if (todo_list_parse_insn_buffer(r, buf->buf, &todo_list)) {
 		todo_list_release(&todo_list);
 		return error(_("unusable todo list: '%s'"), todo_file);
 	}
@@ -4995,7 +4950,7 @@ int rearrange_squash(struct repository *r)
 
 	if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
 		return -1;
-	if (parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
+	if (todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list) < 0) {
 		todo_list_release(&todo_list);
 		return -1;
 	}
sequencer.h +50 -0

56 lines not on this page · raw message

Signature · 1 line
2.20.1
#173 lore raw

PATCH v8 3/18 sequencer: remove the 'arg' field from todo_item

In reply to Alban Gruin

The 'arg' field of todo_item used to store the address of the first byte of the parameter of a command in a todo list. It was associated with the length of the parameter (the 'arg_len' field).

This replaces the 'arg' field by 'arg_offset'. This new field does not store the address of the parameter, but the position of the first character of the parameter in the buffer. todo_item_get_arg() is added to return the address of the parameter of an item.

This will prevent todo_list_add_exec_commands() from having to do awful pointer arithmetics when growing the todo list buffer.

---
No changes since v7.

 sequencer.c | 67 ++++++++++++++++++++++++++++++-----------------------
 sequencer.h |  6 +++--
 2 files changed, 42 insertions(+), 31 deletions(-)
sequencer.c +38 -29
index 25cc7a9a91..c844a9b7f3 100644
@@ -1999,8 +1999,14 @@ static struct todo_item *append_new_todo(struct todo_list *todo_list)
 	return todo_list->items + todo_list->nr++;
 }
 
+const char *todo_item_get_arg(struct todo_list *todo_list,
+			      struct todo_item *item)
+{
+	return todo_list->buf.buf + item->arg_offset;
+}
+
 static int parse_insn_line(struct repository *r, struct todo_item *item,
-			   const char *bol, char *eol)
+			   const char *buf, const char *bol, char *eol)
 {
 	struct object_id commit_oid;
 	char *end_of_object_name;
@@ -2014,7 +2020,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
 		item->command = TODO_COMMENT;
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = eol - bol;
 		return 0;
 	}
@@ -2041,7 +2047,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 			return error(_("%s does not accept arguments: '%s'"),
 				     command_to_string(item->command), bol);
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = eol - bol;
 		return 0;
 	}
@@ -2053,7 +2059,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
 	    item->command == TODO_RESET) {
 		item->commit = NULL;
-		item->arg = bol;
+		item->arg_offset = bol - buf;
 		item->arg_len = (int)(eol - bol);
 		return 0;
 	}
@@ -2067,7 +2073,7 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 		} else {
 			item->flags |= TODO_EDIT_MERGE_MSG;
 			item->commit = NULL;
-			item->arg = bol;
+			item->arg_offset = bol - buf;
 			item->arg_len = (int)(eol - bol);
 			return 0;
 		}
@@ -2079,8 +2085,9 @@ static int parse_insn_line(struct repository *r, struct todo_item *item,
 	status = get_oid(bol, &commit_oid);
 	*end_of_object_name = saved;
 
-	item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
-	item->arg_len = (int)(eol - item->arg);
+	bol = end_of_object_name + strspn(end_of_object_name, " \t");
+	item->arg_offset = bol - buf;
+	item->arg_len = (int)(eol - bol);
 
 	if (status < 0)
 		return -1;
@@ -2108,11 +2115,11 @@ int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 
 		item = append_new_todo(todo_list);
 		item->offset_in_buf = p - todo_list->buf.buf;
-		if (parse_insn_line(r, item, p, eol)) {
+		if (parse_insn_line(r, item, buf, p, eol)) {
 			res = error(_("invalid line %d: %.*s"),
 				i, (int)(eol - p), p);
 			item->command = TODO_COMMENT + 1;
-			item->arg = p;
+			item->arg_offset = p - buf;
 			item->arg_len = (int)(eol - p);
 			item->commit = NULL;
 		}
@@ -2452,7 +2459,7 @@ static int walk_revs_populate_todo(struct todo_list *todo_list,
 
 		item->command = command;
 		item->commit = commit;
-		item->arg = NULL;
+		item->arg_offset = 0;
 		item->arg_len = 0;
 		item->offset_in_buf = todo_list->buf.len;
 		subject_len = find_commit_subject(commit_buffer, &subject);
@@ -3491,6 +3498,8 @@ static int pick_commits(struct repository *r,
 
 	while (todo_list->current < todo_list->nr) {
 		struct todo_item *item = todo_list->items + todo_list->current;
+		const char *arg = todo_item_get_arg(todo_list, item);
+
 		if (save_todo(todo_list, opts))
 			return -1;
 		if (is_rebase_i(opts)) {
@@ -3542,10 +3551,9 @@ static int pick_commits(struct repository *r,
 					fprintf(stderr,
 						_("Stopped at %s...  %.*s\n"),
 						short_commit_name(commit),
-						item->arg_len, item->arg);
+						item->arg_len, arg);
 				return error_with_patch(r, commit,
-					item->arg, item->arg_len, opts, res,
-					!res);
+					arg, item->arg_len, opts, res, !res);
 			}
 			if (is_rebase_i(opts) && !res)
 				record_in_rewritten(&item->commit->object.oid,
@@ -3554,7 +3562,7 @@ static int pick_commits(struct repository *r,
 				if (res == 1)
 					intend_to_amend();
 				return error_failed_squash(r, item->commit, opts,
-					item->arg_len, item->arg);
+					item->arg_len, arg);
 			} else if (res && is_rebase_i(opts) && item->commit) {
 				int to_amend = 0;
 				struct object_id oid;
@@ -3573,16 +3581,16 @@ static int pick_commits(struct repository *r,
 					to_amend = 1;
 
 				return res | error_with_patch(r, item->commit,
-						item->arg, item->arg_len, opts,
+						arg, item->arg_len, opts,
 						res, to_amend);
 			}
 		} else if (item->command == TODO_EXEC) {
-			char *end_of_arg = (char *)(item->arg + item->arg_len);
+			char *end_of_arg = (char *)(arg + item->arg_len);
 			int saved = *end_of_arg;
 			struct stat st;
 
 			*end_of_arg = '\0';
-			res = do_exec(r, item->arg);
+			res = do_exec(r, arg);
 			*end_of_arg = saved;
 
 			/* Reread the todo file if it has changed. */
@@ -3599,14 +3607,14 @@ static int pick_commits(struct repository *r,
 				todo_list->current = -1;
 			}
 		} else if (item->command == TODO_LABEL) {
-			if ((res = do_label(r, item->arg, item->arg_len)))
+			if ((res = do_label(r, arg, item->arg_len)))
 				reschedule = 1;
 		} else if (item->command == TODO_RESET) {
-			if ((res = do_reset(r, item->arg, item->arg_len, opts)))
+			if ((res = do_reset(r, arg, item->arg_len, opts)))
 				reschedule = 1;
 		} else if (item->command == TODO_MERGE) {
 			if ((res = do_merge(r, item->commit,
-					    item->arg, item->arg_len,
+					    arg, item->arg_len,
 					    item->flags, opts)) < 0)
 				reschedule = 1;
 			else if (item->commit)
@@ -3615,9 +3623,8 @@ static int pick_commits(struct repository *r,
 			if (res > 0)
 				/* failed with merge conflicts */
 				return error_with_patch(r, item->commit,
-							item->arg,
-							item->arg_len, opts,
-							res, 0);
+							arg, item->arg_len,
+							opts, res, 0);
 		} else if (!is_noop(item->command))
 			return error(_("unknown command %d"), item->command);
 
@@ -3632,9 +3639,8 @@ static int pick_commits(struct repository *r,
 			if (item->commit)
 				return error_with_patch(r,
 							item->commit,
-							item->arg,
-							item->arg_len, opts,
-							res, 0);
+							arg, item->arg_len,
+							opts, res, 0);
 		}
 
 		todo_list->current++;
@@ -4575,7 +4581,8 @@ int transform_todos(struct repository *r, unsigned flags)
 	for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
 		/* if the item is not a command write it and continue */
 		if (item->command >= TODO_COMMENT) {
-			strbuf_addf(&buf, "%.*s\n", item->arg_len, item->arg);
+			strbuf_addf(&buf, "%.*s\n", item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 			continue;
 		}
 
@@ -4605,7 +4612,8 @@ int transform_todos(struct repository *r, unsigned flags)
 		if (!item->arg_len)
 			strbuf_addch(&buf, '\n');
 		else
-			strbuf_addf(&buf, " %.*s\n", item->arg_len, item->arg);
+			strbuf_addf(&buf, " %.*s\n", item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 	}
 
 	i = write_message(buf.buf, buf.len, todo_file, 0);
@@ -4681,7 +4689,8 @@ int check_todo_list(struct repository *r)
 		if (commit && !*commit_seen_at(&commit_seen, commit)) {
 			strbuf_addf(&missing, " - %s %.*s\n",
 				    short_commit_name(commit),
-				    item->arg_len, item->arg);
+				    item->arg_len,
+				    todo_item_get_arg(&todo_list, item));
 			*commit_seen_at(&commit_seen, commit) = 1;
 		}
 	}
sequencer.h +4 -2
index c6360bac66..50d552429c 100644
@@ -104,9 +104,9 @@ struct todo_item {
 	enum todo_command command;
 	struct commit *commit;
 	unsigned int flags;
-	const char *arg;
 	int arg_len;
-	size_t offset_in_buf;
+	/* The offset of the command and its argument in the strbuf */
+	size_t offset_in_buf, arg_offset;
 };
 
 struct todo_list {
@@ -122,6 +122,8 @@ struct todo_list {
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
 void todo_list_release(struct todo_list *todo_list);
+const char *todo_item_get_arg(struct todo_list *todo_list,
+			      struct todo_item *item);
 
 /* Call this to setup defaults before parsing command line options */
 void sequencer_init_config(struct replay_opts *opts);
Signature · 1 line
2.20.1
#174 lore raw

PATCH v8 4/18 sequencer: refactor transform_todos() to work on a todo_list

In reply to Alban Gruin

This refactors transform_todos() to work on a todo_list. The function is renamed todo_list_transform().

As rebase -p still need to check the todo list from the disk, a new function is introduced, transform_todo_file(). It is still used by complete_action() and edit_todo_list() for now, but they will be replaced in a future commit.

todo_list_transform() is not a static function, because it will be used by edit_todo_list() from rebase-interactive.c in a future commit.

---
No changes since v7.

 builtin/rebase--interactive.c |  2 +-
 rebase-interactive.c          |  4 +--
 sequencer.c                   | 54 +++++++++++++++++++++++------------
 sequencer.h                   |  4 ++-
 4 files changed, 42 insertions(+), 22 deletions(-)
builtin/rebase--interactive.c +1 -1
index dd2a55ab1d..0898eb4c59 100644
@@ -253,7 +253,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	case SHORTEN_OIDS:
 	case EXPAND_OIDS:
-		ret = transform_todos(the_repository, flags);
+		ret = transform_todo_file(the_repository, flags);
 		break;
 	case CHECK_TODO_LIST:
 		ret = check_todo_list(the_repository);
rebase-interactive.c +2 -2
index 68aff1dac2..842fa07e7e 100644
@@ -69,7 +69,7 @@ int edit_todo_list(struct repository *r, unsigned flags)
 
 	strbuf_release(&buf);
 
-	transform_todos(r, flags | TODO_LIST_SHORTEN_IDS);
+	transform_todo_file(r, flags | TODO_LIST_SHORTEN_IDS);
 
 	if (strbuf_read_file(&buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
@@ -85,7 +85,7 @@ int edit_todo_list(struct repository *r, unsigned flags)
 	if (launch_sequence_editor(todo_file, NULL, NULL))
 		return -1;
 
-	transform_todos(r, flags & ~(TODO_LIST_SHORTEN_IDS));
+	transform_todo_file(r, flags & ~(TODO_LIST_SHORTEN_IDS));
 
 	return 0;
 }
sequencer.c +36 -18

89 lines not on this page · raw message

sequencer.h +3 -1
index 50d552429c..2ddb20cbc1 100644
@@ -121,6 +121,8 @@ struct todo_list {
 
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
+void todo_list_transform(struct repository *r, struct todo_list *todo_list,
+			 unsigned flags);
 void todo_list_release(struct todo_list *todo_list);
 const char *todo_item_get_arg(struct todo_list *todo_list,
 			      struct todo_item *item);
@@ -148,7 +150,7 @@ int sequencer_make_script(struct repository *repo, FILE *out,
 			  unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
-int transform_todos(struct repository *r, unsigned flags);
+int transform_todo_file(struct repository *r, unsigned flags);
 enum missing_commit_check_level get_missing_commit_check_level(void);
 int check_todo_list(struct repository *r);
 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
Signature · 1 line
2.20.1
#175 lore raw

PATCH v8 5/18 sequencer: introduce todo_list_write_to_file()

In reply to Alban Gruin

This introduces a new function to recreate the text of a todo list from its commands and write it to a file. This will be useful as the next few commits will change the use of the buffer in struct todo_list so it will no longer be a mirror of the file on disk.

This functionality already exists in todo_list_transform(), but this function was made to replace the buffer of a todo list, which is not what we want here. Thus, the part of todo_list_transform() that replaces the buffer is dropped, and the function is renamed todo_list_to_strbuf(). It is called by todo_list_write_to_file() to fill the buffer to write to the disk.

todo_list_write_to_file() can also take care of appending the help text to the buffer before writing it to the disk, or to write only the first n items of the list. This feature will be used by skip_unnecessary_picks(), which has to write done commands in a file.

---
No changes since v7.

 sequencer.c | 61 +++++++++++++++++++++++++++++++++++------------------
 sequencer.h | 11 ++++++----
 2 files changed, 48 insertions(+), 24 deletions(-)
sequencer.c +41 -20
index 346706029c..4809b22ce4 100644
@@ -4562,26 +4562,28 @@ int sequencer_add_exec_commands(struct repository *r,
 	return i;
 }
 
-void todo_list_transform(struct repository *r, struct todo_list *todo_list,
-			 unsigned flags)
+static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
+				struct strbuf *buf, int num, unsigned flags)
 {
-	struct strbuf buf = STRBUF_INIT;
 	struct todo_item *item;
-	int i;
+	int i, max = todo_list->nr;
 
-	for (item = todo_list->items, i = 0; i < todo_list->nr; i++, item++) {
+	if (num > 0 && num < max)
+		max = num;
+
+	for (item = todo_list->items, i = 0; i < max; i++, item++) {
 		/* if the item is not a command write it and continue */
 		if (item->command >= TODO_COMMENT) {
-			strbuf_addf(&buf, "%.*s\n", item->arg_len,
+			strbuf_addf(buf, "%.*s\n", item->arg_len,
 				    todo_item_get_arg(todo_list, item));
 			continue;
 		}
 
 		/* add command to the buffer */
 		if (flags & TODO_LIST_ABBREVIATE_CMDS)
-			strbuf_addch(&buf, command_to_char(item->command));
+			strbuf_addch(buf, command_to_char(item->command));
 		else
-			strbuf_addstr(&buf, command_to_string(item->command));
+			strbuf_addstr(buf, command_to_string(item->command));
 
 		/* add commit id */
 		if (item->commit) {
@@ -4591,28 +4593,48 @@ void todo_list_transform(struct repository *r, struct todo_list *todo_list,
 
 			if (item->command == TODO_MERGE) {
 				if (item->flags & TODO_EDIT_MERGE_MSG)
-					strbuf_addstr(&buf, " -c");
+					strbuf_addstr(buf, " -c");
 				else
-					strbuf_addstr(&buf, " -C");
+					strbuf_addstr(buf, " -C");
 			}
 
-			strbuf_addf(&buf, " %s", oid);
+			strbuf_addf(buf, " %s", oid);
 		}
 
 		/* add all the rest */
 		if (!item->arg_len)
-			strbuf_addch(&buf, '\n');
+			strbuf_addch(buf, '\n');
 		else
-			strbuf_addf(&buf, " %.*s\n", item->arg_len,
+			strbuf_addf(buf, " %.*s\n", item->arg_len,
 				    todo_item_get_arg(todo_list, item));
 	}
+}
 
-	strbuf_reset(&todo_list->buf);
-	strbuf_add(&todo_list->buf, buf.buf, buf.len);
+int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
+			    const char *file, const char *shortrevisions,
+			    const char *shortonto, int num, unsigned flags)
+{
+	int edit_todo = !(shortrevisions && shortonto), res;
+	struct strbuf buf = STRBUF_INIT;
+
+	todo_list_to_strbuf(r, todo_list, &buf, num, flags);
+
+	if (flags & TODO_LIST_APPEND_TODO_HELP) {
+		int command_count = count_commands(todo_list);
+		if (!edit_todo) {
+			strbuf_addch(&buf, '\n');
+			strbuf_commented_addf(&buf, Q_("Rebase %s onto %s (%d command)",
+						       "Rebase %s onto %s (%d commands)",
+						       command_count),
+					      shortrevisions, shortonto, command_count);
+		}
+		append_todo_help(edit_todo, flags & TODO_LIST_KEEP_EMPTY, &buf);
+	}
+
+	res = write_message(buf.buf, buf.len, file, 0);
 	strbuf_release(&buf);
 
-	if (todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list))
-		BUG("unusable todo list");
+	return res;
 }
 
 int transform_todo_file(struct repository *r, unsigned flags)
@@ -4629,9 +4651,8 @@ int transform_todo_file(struct repository *r, unsigned flags)
 		return error(_("unusable todo list: '%s'"), todo_file);
 	}
 
-	todo_list_transform(r, &todo_list, flags);
-
-	res = write_message(todo_list.buf.buf, todo_list.buf.len, todo_file, 0);
+	res = todo_list_write_to_file(r, &todo_list, todo_file,
+				      NULL, NULL, -1, flags);
 	todo_list_release(&todo_list);
 
 	if (res)
sequencer.h +7 -4
index 2ddb20cbc1..7278f9675b 100644
@@ -121,8 +121,9 @@ struct todo_list {
 
 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 				struct todo_list *todo_list);
-void todo_list_transform(struct repository *r, struct todo_list *todo_list,
-			 unsigned flags);
+int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
+			    const char *file, const char *shortrevisions,
+			    const char *shortonto, int num, unsigned flags);
 void todo_list_release(struct todo_list *todo_list);
 const char *todo_item_get_arg(struct todo_list *todo_list,
 			      struct todo_item *item);
@@ -145,8 +146,10 @@ int sequencer_remove_state(struct replay_opts *opts);
  * commits should be rebased onto the new base, this flag needs to be passed.
  */
 #define TODO_LIST_REBASE_COUSINS (1U << 4)
-int sequencer_make_script(struct repository *repo, FILE *out,
-			  int argc, const char **argv,
+#define TODO_LIST_APPEND_TODO_HELP (1U << 5)
+
+int sequencer_make_script(struct repository *r, FILE *out, int argc,
+			  const char **argv,
 			  unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
Signature · 1 line
2.20.1
#176 lore raw

PATCH v8 6/18 sequencer: refactor check_todo_list() to work on a todo_list

In reply to Alban Gruin

This refactors check_todo_list() to work on a todo_list to avoid redundant reads and writes to the disk. The function is renamed todo_list_check(). The parsing of the two todo lists is left to the caller.

As rebase -p still need to check the todo list from the disk, a new function is introduced, check_todo_list_from_file(). It reads the file from the disk, parses it, pass the todo_list to todo_list_check(), and writes it back to the disk.

As get_missing_commit_check_level() and the enum missing_commit_check_level are no longer needed inside of sequencer.c, they are moved to rebase-interactive.c, and made static again.

---
No changes since v7.

 builtin/rebase--interactive.c |   2 +-
 rebase-interactive.c          |  91 ++++++++++++++++++++++++-
 rebase-interactive.h          |   2 +
 sequencer.c                   | 121 +++++++---------------------------
 sequencer.h                   |   9 +--
 5 files changed, 117 insertions(+), 108 deletions(-)
builtin/rebase--interactive.c +1 -1
index 0898eb4c59..df19ccaeb9 100644
@@ -256,7 +256,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = transform_todo_file(the_repository, flags);
 		break;
 	case CHECK_TODO_LIST:
-		ret = check_todo_list(the_repository);
+		ret = check_todo_list_from_file(the_repository);
 		break;
 	case REARRANGE_SQUASH:
 		ret = rearrange_squash(the_repository);
rebase-interactive.c +90 -1

101 lines not on this page · raw message

rebase-interactive.h +2 -0
index 17b6c9f6d0..187b5032d6 100644
@@ -3,9 +3,11 @@
 
 struct strbuf;
 struct repository;
+struct todo_list;
 
 void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 		      struct strbuf *buf);
 int edit_todo_list(struct repository *r, unsigned flags);
+int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +23 -98

142 lines not on this page · raw message

sequencer.h +1 -8
index 7278f9675b..217353e9f0 100644
@@ -64,12 +64,6 @@ struct replay_opts {
 };
 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
 
-enum missing_commit_check_level {
-	MISSING_COMMIT_CHECK_IGNORE = 0,
-	MISSING_COMMIT_CHECK_WARN,
-	MISSING_COMMIT_CHECK_ERROR
-};
-
 int write_message(const void *buf, size_t len, const char *filename,
 		  int append_eol);
 
@@ -154,8 +148,7 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 
 int sequencer_add_exec_commands(struct repository *r, const char *command);
 int transform_todo_file(struct repository *r, unsigned flags);
-enum missing_commit_check_level get_missing_commit_check_level(void);
-int check_todo_list(struct repository *r);
+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, const char *cmd,
Signature · 1 line
2.20.1
#177 lore raw

PATCH v8 7/18 sequencer: refactor sequencer_add_exec_commands() to work on a todo_list

In reply to Alban Gruin

This refactors sequencer_add_exec_commands() to work on a todo_list to avoid redundant reads and writes to the disk.

Instead of inserting the `exec' commands between the other commands and re-parsing the buffer at the end, they are appended to the buffer once, and a new list of items is created. Items from the old list are copied across and new `exec' items are appended when necessary. This eliminates the need to reparse the buffer, but this also means we have to use todo_list_write_to_disk() to write the file.

todo_list_add_exec_commands() and sequencer_add_exec_commands() are modified to take a string list instead of a string -- one item for each command. This makes it easier to insert a new command to the todo list for each command to execute.

sequencer_add_exec_commands() still reads the todo list from the disk, as it is needed by rebase -p.

complete_action() still uses sequencer_add_exec_commands() for now. This will be changed in a future commit.

---
 builtin/rebase--interactive.c |  18 ++++--
 sequencer.c                   | 114 ++++++++++++++++++++++------------
 sequencer.h                   |   5 +-
 3 files changed, 91 insertions(+), 46 deletions(-)
builtin/rebase--interactive.c +14 -4
index df19ccaeb9..813bc34140 100644
@@ -65,7 +65,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 				 const char *onto, const char *onto_name,
 				 const char *squash_onto, const char *head_name,
 				 const char *restrict_revision, char *raw_strategies,
-				 const char *cmd, unsigned autosquash)
+				 struct string_list *commands, unsigned autosquash)
 {
 	int ret;
 	const char *head_hash = NULL;
@@ -116,7 +116,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 		discard_cache();
 		ret = complete_action(the_repository, opts, flags,
 				      shortrevisions, onto_name, onto,
-				      head_hash, cmd, autosquash);
+				      head_hash, commands, autosquash);
 	}
 
 	free(revisions);
@@ -139,6 +139,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	const char *onto = NULL, *onto_name = NULL, *restrict_revision = NULL,
 		*squash_onto = NULL, *upstream = NULL, *head_name = NULL,
 		*switch_to = NULL, *cmd = NULL;
+	struct string_list commands = STRING_LIST_INIT_DUP;
 	char *raw_strategies = NULL;
 	enum {
 		NONE = 0, CONTINUE, SKIP, EDIT_TODO, SHOW_CURRENT_PATCH,
@@ -221,6 +222,14 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		warning(_("--[no-]rebase-cousins has no effect without "
 			  "--rebase-merges"));
 
+	if (cmd && *cmd) {
+		string_list_split(&commands, cmd, '\n', -1);
+
+		/* 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) {
 	case NONE:
 		if (!onto && !upstream)
@@ -228,7 +237,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 
 		ret = do_interactive_rebase(&opts, flags, switch_to, upstream, onto,
 					    onto_name, squash_onto, head_name, restrict_revision,
-					    raw_strategies, cmd, autosquash);
+					    raw_strategies, &commands, autosquash);
 		break;
 	case SKIP: {
 		struct string_list merge_rr = STRING_LIST_INIT_DUP;
@@ -262,11 +271,12 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, cmd);
+		ret = sequencer_add_exec_commands(the_repository, &commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
 	}
 
+	string_list_clear(&commands, 0);
 	return !!ret;
 }
sequencer.c +74 -40

150 lines not on this page · raw message

sequencer.h +3 -2
index 217353e9f0..87d04a3b9b 100644
@@ -146,12 +146,13 @@ int sequencer_make_script(struct repository *r, FILE *out, int argc,
 			  const char **argv,
 			  unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r, const char *command);
+int sequencer_add_exec_commands(struct repository *r,
+				struct string_list *commands);
 int transform_todo_file(struct repository *r, unsigned flags);
 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, const char *cmd,
+		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
 int rearrange_squash(struct repository *r);
 
Signature · 1 line
2.20.1
#178 lore raw

PATCH v8 8/18 sequencer: refactor rearrange_squash() to work on a todo_list

In reply to Alban Gruin

This refactors rearrange_squash() to work on a todo_list to avoid redundant reads and writes. The function is renamed todo_list_rearrange_squash().

The old version created a new buffer, which was directly written to the disk. This new version creates a new item list by just copying items from the old item list, without creating a new buffer. This eliminates the need to reparse the todo list, but this also means its buffer cannot be directly written to the disk.

As rebase -p still need to check the todo list from the disk, a new function is introduced, rearrange_squash_in_todo_file().

complete_action() still uses rearrange_squash_in_todo_file() for now. This will be changed in a future commit.

---
No changes since v7.

 builtin/rebase--interactive.c |  2 +-
 sequencer.c                   | 92 ++++++++++++++++++-----------------
 sequencer.h                   |  2 +-
 3 files changed, 49 insertions(+), 47 deletions(-)
builtin/rebase--interactive.c +1 -1
index 813bc34140..60b15f9693 100644
@@ -268,7 +268,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = check_todo_list_from_file(the_repository);
 		break;
 	case REARRANGE_SQUASH:
-		ret = rearrange_squash(the_repository);
+		ret = rearrange_squash_in_todo_file(the_repository);
 		break;
 	case ADD_EXEC:
 		ret = sequencer_add_exec_commands(the_repository, &commands);
sequencer.c +47 -45

156 lines not on this page · raw message

sequencer.h +1 -1
index 87d04a3b9b..add50f04f1 100644
@@ -154,7 +154,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		    const char *shortrevisions, const char *onto_name,
 		    const char *onto, const char *orig_head, struct string_list *commands,
 		    unsigned autosquash);
-int rearrange_squash(struct repository *r);
+int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
 
Signature · 1 line
2.20.1
#179 lore raw

PATCH v8 9/18 sequencer: make sequencer_make_script() write its script to a strbuf

In reply to Alban Gruin

This makes sequencer_make_script() write its script to a strbuf (ie. the buffer of a todo_list) instead of a FILE. This reduce the amount of read/write made by rebase interactive.

---
No changes since v7.

 builtin/rebase--interactive.c | 13 ++++++-----
 sequencer.c                   | 41 +++++++++++++++--------------------
 sequencer.h                   |  5 ++---
 3 files changed, 28 insertions(+), 31 deletions(-)
builtin/rebase--interactive.c +8 -5
index 60b15f9693..b4190e58e1 100644
@@ -71,7 +71,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list;
+	FILE *todo_list_file;
+	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
 		return -1;
@@ -93,8 +94,8 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list = fopen(rebase_path_todo(), "w");
-	if (!todo_list) {
+	todo_list_file = fopen(rebase_path_todo(), "w");
+	if (!todo_list_file) {
 		free(revisions);
 		free(shortrevisions);
 
@@ -105,10 +106,11 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
 
-	ret = sequencer_make_script(the_repository, todo_list,
+	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fclose(todo_list);
+	fputs(todo_list.buf.buf, todo_list_file);
+	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
@@ -121,6 +123,7 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 
 	free(revisions);
 	free(shortrevisions);
+	todo_list_release(&todo_list);
 	argv_array_clear(&make_script_args);
 
 	return ret;
sequencer.c +18 -23

101 lines not on this page · raw message

sequencer.h +2 -3
index add50f04f1..e25f5151d3 100644
@@ -142,9 +142,8 @@ int sequencer_remove_state(struct replay_opts *opts);
 #define TODO_LIST_REBASE_COUSINS (1U << 4)
 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
 
-int sequencer_make_script(struct repository *r, FILE *out, int argc,
-			  const char **argv,
-			  unsigned flags);
+int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
+			  const char **argv, unsigned flags);
 
 int sequencer_add_exec_commands(struct repository *r,
 				struct string_list *commands);
Signature · 1 line
2.20.1
#180 lore raw

PATCH v8 10/18 sequencer: change complete_action() to use the refactored functions

In reply to Alban Gruin

complete_action() used functions that read the todo-list file, made some changes to it, and wrote it back to the disk.

The previous commits were dedicated to separate the part that deals with the file from the actual logic of these functions. Now that this is done, we can call directly the "logic" functions to avoid useless file access.

The parsing of the list has to be done by the caller. If the buffer of the todo list provided by the caller is empty, a `noop' command is directly added to the todo list, without touching the buffer.

---
No changes since v7.

 builtin/rebase--interactive.c | 20 +++------
 sequencer.c                   | 79 +++++++++++++++--------------------
 sequencer.h                   |  2 +-
 3 files changed, 41 insertions(+), 60 deletions(-)
builtin/rebase--interactive.c +6 -14
index b4190e58e1..ffbe14cef5 100644
@@ -71,7 +71,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	const char *head_hash = NULL;
 	char *revisions = NULL, *shortrevisions = NULL;
 	struct argv_array make_script_args = ARGV_ARRAY_INIT;
-	FILE *todo_list_file;
 	struct todo_list todo_list = TODO_LIST_INIT;
 
 	if (prepare_branch_to_be_rebased(opts, switch_to))
@@ -94,14 +93,6 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	if (!upstream && squash_onto)
 		write_file(path_squash_onto(), "%s\n", squash_onto);
 
-	todo_list_file = fopen(rebase_path_todo(), "w");
-	if (!todo_list_file) {
-		free(revisions);
-		free(shortrevisions);
-
-		return error_errno(_("could not open %s"), rebase_path_todo());
-	}
-
 	argv_array_pushl(&make_script_args, "", revisions, NULL);
 	if (restrict_revision)
 		argv_array_push(&make_script_args, restrict_revision);
@@ -109,16 +100,17 @@ static int do_interactive_rebase(struct replay_opts *opts, unsigned flags,
 	ret = sequencer_make_script(the_repository, &todo_list.buf,
 				    make_script_args.argc, make_script_args.argv,
 				    flags);
-	fputs(todo_list.buf.buf, todo_list_file);
-	fclose(todo_list_file);
 
 	if (ret)
 		error(_("could not generate todo list"));
 	else {
 		discard_cache();
-		ret = complete_action(the_repository, opts, flags,
-				      shortrevisions, onto_name, onto,
-				      head_hash, commands, autosquash);
+		if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
+						&todo_list))
+			BUG("unusable todo list");
+
+		ret = complete_action(the_repository, opts, flags, shortrevisions, onto_name,
+				      onto, head_hash, commands, autosquash, &todo_list);
 	}
 
 	free(revisions);
sequencer.c +34 -45

127 lines not on this page · raw message

sequencer.h +1 -1
index e25f5151d3..7029b39cd6 100644
@@ -152,7 +152,7 @@ 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);
+		    unsigned autosquash, struct todo_list *todo_list);
 int rearrange_squash_in_todo_file(struct repository *r);
 
 extern const char sign_off_header[];
Signature · 1 line
2.20.1
#181 lore raw

PATCH v8 11/18 rebase--interactive: move sequencer_add_exec_commands()

In reply to Alban Gruin

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 along the way.

---
New commit, but was a part of "rebase--interactive: move several functions to rebase--interactive.c" from the v7.

 builtin/rebase--interactive.c | 27 ++++++++++++++++++++++++++-
 sequencer.c                   | 28 ++--------------------------
 sequencer.h                   |  4 ++--
 3 files changed, 30 insertions(+), 29 deletions(-)
builtin/rebase--interactive.c +26 -1
index ffbe14cef5..3bf1da6940 100644
@@ -13,6 +13,31 @@ static GIT_PATH_FUNC(path_state_dir, "rebase-merge/")
 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
 
+static int add_exec_commands(struct string_list *commands)
+{
+	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);
+	}
+
+	todo_list_add_exec_commands(&todo_list, commands);
+	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 get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -266,7 +291,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		ret = rearrange_squash_in_todo_file(the_repository);
 		break;
 	case ADD_EXEC:
-		ret = sequencer_add_exec_commands(the_repository, &commands);
+		ret = add_exec_commands(&commands);
 		break;
 	default:
 		BUG("invalid command '%d'", command);
sequencer.c +2 -26
index 1d5cd2fc27..280d9bcce7 100644
@@ -4500,8 +4500,8 @@ int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
  * Add commands after pick and (series of) squash/fixup commands
  * in the todo list.
  */
-static void todo_list_add_exec_commands(struct todo_list *todo_list,
-					struct string_list *commands)
+void todo_list_add_exec_commands(struct todo_list *todo_list,
+				 struct string_list *commands)
 {
 	struct strbuf *buf = &todo_list->buf;
 	size_t base_offset = buf->len;
@@ -4567,30 +4567,6 @@ static void todo_list_add_exec_commands(struct todo_list *todo_list,
 	todo_list->alloc = alloc;
 }
 
-int sequencer_add_exec_commands(struct repository *r,
-				struct string_list *commands)
-{
-	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);
-	}
-
-	todo_list_add_exec_commands(&todo_list, commands);
-	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;
-}
-
 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
 				struct strbuf *buf, int num, unsigned flags)
 {
sequencer.h +2 -2
index 7029b39cd6..0c4b7c80f8 100644
@@ -145,9 +145,9 @@ int sequencer_remove_state(struct replay_opts *opts);
 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 			  const char **argv, unsigned flags);
 
-int sequencer_add_exec_commands(struct repository *r,
-				struct string_list *commands);
 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,
Signature · 1 line
2.20.1
#182 lore raw

PATCH v8 12/18 rebase--interactive: move rearrange_squash_in_todo_file()

In reply to Alban Gruin

As rearrange_squash_in_todo_file() is only needed inside of rebase--interactive.c for `rebase -p', it is moved there from sequencer.c.

The parameter r (repository) is dropped along the way, and the error handling is slightly improved.

---
New commit, but was a part of "rebase--interactive: move several functions to rebase--interactive.c" from the v7.

 builtin/rebase--interactive.c | 28 +++++++++++++++++++++++++++-
 sequencer.c                   | 28 +---------------------------
 sequencer.h                   |  2 +-
 3 files changed, 29 insertions(+), 29 deletions(-)
builtin/rebase--interactive.c +27 -1
index 3bf1da6940..ab2c6fcd99 100644
@@ -38,6 +38,32 @@ static int add_exec_commands(struct string_list *commands)
 	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 get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -288,7 +314,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		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();
 		break;
 	case ADD_EXEC:
 		ret = add_exec_commands(&commands);
sequencer.c +1 -27
index 280d9bcce7..ffa4334982 100644
@@ -4793,8 +4793,6 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 	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,
@@ -4906,7 +4904,7 @@ define_commit_slab(commit_todo_item, struct todo_item *);
  * 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;
@@ -5044,27 +5042,3 @@ static int todo_list_rearrange_squash(struct todo_list *todo_list)
 
 	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;
-}
sequencer.h +1 -1
index 0c4b7c80f8..13c5676c24 100644
@@ -153,7 +153,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		    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[];
 
Signature · 1 line
2.20.1
#183 lore raw

PATCH v8 13/18 sequencer: refactor skip_unnecessary_picks() to work on a todo_list

In reply to Alban Gruin

This refactors skip_unnecessary_picks() to work on a todo_list. As this function is only called by complete_action() (and thus is not used by rebase -p), the file-handling logic is completely dropped here.

Instead of truncating the todo list’s buffer, the items are moved to the beginning of the list, eliminating the need to reparse the list. This also means its buffer cannot be directly written to the disk.

rewrite_file() is then removed, as it is now unused.

---
No changes since v7.

 sequencer.c | 82 +++++++++++++----------------------------------------
 1 file changed, 19 insertions(+), 63 deletions(-)
sequencer.c +19 -63
index ffa4334982..894c7538d5 100644
@@ -4700,52 +4700,22 @@ int check_todo_list_from_file(struct repository *r)
 	return res;
 }
 
-static int rewrite_file(const char *path, const char *buf, size_t len)
-{
-	int rc = 0;
-	int fd = open(path, O_WRONLY | O_TRUNC);
-	if (fd < 0)
-		return error_errno(_("could not open '%s' for writing"), path);
-	if (write_in_full(fd, buf, len) < 0)
-		rc = error_errno(_("could not write to '%s'"), path);
-	if (close(fd) && !rc)
-		rc = error_errno(_("could not close '%s'"), path);
-	return rc;
-}
-
 /* skip picking commits whose parents are unchanged */
-static int skip_unnecessary_picks(struct repository *r, struct object_id *output_oid)
+static int skip_unnecessary_picks(struct repository *r,
+				  struct todo_list *todo_list,
+				  struct object_id *base_oid)
 {
-	const char *todo_file = rebase_path_todo();
-	struct strbuf buf = STRBUF_INIT;
-	struct todo_list todo_list = TODO_LIST_INIT;
 	struct object_id *parent_oid;
-	int fd, i;
-
-	if (!read_oneliner(&buf, rebase_path_onto(), 0))
-		return error(_("could not read 'onto'"));
-	if (get_oid(buf.buf, output_oid)) {
-		strbuf_release(&buf);
-		return error(_("need a HEAD to fixup"));
-	}
-	strbuf_release(&buf);
-
-	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;
-	}
+	int i;
 
-	for (i = 0; i < todo_list.nr; i++) {
-		struct todo_item *item = todo_list.items + i;
+	for (i = 0; i < todo_list->nr; i++) {
+		struct todo_item *item = todo_list->items + i;
 
 		if (item->command >= TODO_NOOP)
 			continue;
 		if (item->command != TODO_PICK)
 			break;
 		if (parse_commit(item->commit)) {
-			todo_list_release(&todo_list);
 			return error(_("could not parse commit '%s'"),
 				oid_to_hex(&item->commit->object.oid));
 		}
@@ -4754,42 +4724,26 @@ static int skip_unnecessary_picks(struct repository *r, struct object_id *output
 		if (item->commit->parents->next)
 			break; /* merge commit */
 		parent_oid = &item->commit->parents->item->object.oid;
-		if (!oideq(parent_oid, output_oid))
+		if (!oideq(parent_oid, base_oid))
 			break;
-		oidcpy(output_oid, &item->commit->object.oid);
+		oidcpy(base_oid, &item->commit->object.oid);
 	}
 	if (i > 0) {
-		int offset = get_item_line_offset(&todo_list, i);
 		const char *done_path = rebase_path_done();
 
-		fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
-		if (fd < 0) {
-			error_errno(_("could not open '%s' for writing"),
-				    done_path);
-			todo_list_release(&todo_list);
-			return -1;
-		}
-		if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
+		if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
 			error_errno(_("could not write to '%s'"), done_path);
-			todo_list_release(&todo_list);
-			close(fd);
 			return -1;
 		}
-		close(fd);
 
-		if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
-				 todo_list.buf.len - offset) < 0) {
-			todo_list_release(&todo_list);
-			return -1;
-		}
+		MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
+		todo_list->nr -= i;
+		todo_list->current = 0;
 
-		todo_list.current = i;
-		if (is_fixup(peek_command(&todo_list, 0)))
-			record_in_rewritten(output_oid, peek_command(&todo_list, 0));
+		if (is_fixup(peek_command(todo_list, 0)))
+			record_in_rewritten(base_oid, peek_command(todo_list, 0));
 	}
 
-	todo_list_release(&todo_list);
-
 	return 0;
 }
 
@@ -4860,6 +4814,11 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return -1;
 	}
 
+	if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
+		todo_list_release(&new_todo);
+		return error(_("could not skip unnecessary pick commands"));
+	}
+
 	if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
 				    flags & ~(TODO_LIST_SHORTEN_IDS))) {
 		todo_list_release(&new_todo);
@@ -4868,9 +4827,6 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 
 	todo_list_release(&new_todo);
 
-	if (opts->allow_ff && skip_unnecessary_picks(r, &oid))
-		return error(_("could not skip unnecessary pick commands"));
-
 	if (checkout_onto(opts, onto_name, oid_to_hex(&oid), orig_head))
 		return -1;
 
Signature · 1 line
2.20.1
#184 lore raw

PATCH v8 14/18 rebase-interactive: use todo_list_write_to_file() in edit_todo_list()

In reply to Alban Gruin

Just like complete_action(), edit_todo_list() used a function (transform_todo_file()) that read the todo list from the disk and wrote it back, resulting in useless disk accesses.

This changes edit_todo_list() to call directly todo_list_write_to_file() instead.

---
No changes since v7.

 rebase-interactive.c | 38 ++++++++++++++++----------------------
 sequencer.c          |  4 ++--
 sequencer.h          |  3 ---
 3 files changed, 18 insertions(+), 27 deletions(-)
rebase-interactive.c +16 -22
index dfa6dd530f..d396ecc599 100644
@@ -79,39 +79,33 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 
 int edit_todo_list(struct repository *r, unsigned flags)
 {
-	struct strbuf buf = STRBUF_INIT;
 	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT;
+	int res = 0;
 
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
+	if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 		return error_errno(_("could not read '%s'."), todo_file);
 
-	strbuf_stripspace(&buf, 1);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_stripspace(&todo_list.buf, 1);
+	todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list);
+	if (todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
-
-	transform_todo_file(r, flags | TODO_LIST_SHORTEN_IDS);
-
-	if (strbuf_read_file(&buf, todo_file, 0) < 0)
-		return error_errno(_("could not read '%s'."), todo_file);
-
-	append_todo_help(1, 0, &buf);
-	if (write_message(buf.buf, buf.len, todo_file, 0)) {
-		strbuf_release(&buf);
+	strbuf_reset(&todo_list.buf);
+	if (launch_sequence_editor(todo_file, &todo_list.buf, NULL)) {
+		todo_list_release(&todo_list);
 		return -1;
 	}
 
-	strbuf_release(&buf);
+	if (!todo_list_parse_insn_buffer(r, todo_list.buf.buf, &todo_list))
+		res = todo_list_write_to_file(r, &todo_list, todo_file, NULL, NULL, -1,
+					      flags & ~(TODO_LIST_SHORTEN_IDS));
 
-	if (launch_sequence_editor(todo_file, NULL, NULL))
-		return -1;
-
-	transform_todo_file(r, flags & ~(TODO_LIST_SHORTEN_IDS));
-
-	return 0;
+	todo_list_release(&todo_list);
+	return res;
 }
 
 define_commit_slab(commit_seen, unsigned char);
sequencer.c +2 -2
index 894c7538d5..b7289c93d4 100644
@@ -383,8 +383,8 @@ static void print_advice(struct repository *r, int show_hint,
 	}
 }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol)
+static int write_message(const void *buf, size_t len, const char *filename,
+			 int append_eol)
 {
 	struct lock_file msg_file = LOCK_INIT;
 
sequencer.h +0 -3
index 13c5676c24..fb31a30d15 100644
@@ -64,9 +64,6 @@ struct replay_opts {
 };
 #define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
 
-int write_message(const void *buf, size_t len, const char *filename,
-		  int append_eol);
-
 /*
  * Note that ordering matters in this enum. Not only must it match the mapping
  * of todo_command_info (in sequencer.c), it is also divided into several
Signature · 1 line
2.20.1
#185 lore raw

PATCH v8 15/18 rebase-interactive: append_todo_help() changes

In reply to Alban Gruin

This moves the writing of the comment "Rebase $shortrevisions onto $shortonto ($command_count commands)" from todo_list_write_to_file() to append_todo_help().

shortrevisions, shortonto, and command_count are passed as parameters to append_todo_help().

During the initial edit of the todo list, shortrevisions and shortonto are not NULL. Therefore, if shortrevisions or shortonto is NULL, then edit_todo would be true, otherwise it would be false. Thus, edit_todo is removed from the parameters of append_todo_help().

---
No changes since v7.

 rebase-interactive.c | 12 +++++++++++-
 rebase-interactive.h |  3 ++-
 sequencer.c          | 17 ++++-------------
 3 files changed, 17 insertions(+), 15 deletions(-)
rebase-interactive.c +11 -1
index d396ecc599..807f8370db 100644
@@ -28,7 +28,8 @@ static enum missing_commit_check_level get_missing_commit_check_level(void)
 	return MISSING_COMMIT_CHECK_IGNORE;
 }
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf)
 {
 	const char *msg = _("\nCommands:\n"
@@ -48,6 +49,15 @@ void append_todo_help(unsigned edit_todo, unsigned keep_empty,
 ".       specified). Use -c <commit> to reword the commit message.\n"
 "\n"
 "These lines can be re-ordered; they are executed from top to bottom.\n");
+	unsigned edit_todo = !(shortrevisions && shortonto);
+
+	if (!edit_todo) {
+		strbuf_addch(buf, '\n');
+		strbuf_commented_addf(buf, Q_("Rebase %s onto %s (%d command)",
+					      "Rebase %s onto %s (%d commands)",
+					      command_count),
+				      shortrevisions, shortonto, command_count);
+	}
 
 	strbuf_add_commented_lines(buf, msg, strlen(msg));
 
rebase-interactive.h +2 -1
index 187b5032d6..0e5925e3aa 100644
@@ -5,7 +5,8 @@ struct strbuf;
 struct repository;
 struct todo_list;
 
-void append_todo_help(unsigned edit_todo, unsigned keep_empty,
+void append_todo_help(unsigned keep_empty, int command_count,
+		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
 int edit_todo_list(struct repository *r, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
sequencer.c +4 -13
index b7289c93d4..8f3836c479 100644
@@ -4619,22 +4619,13 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 			    const char *file, const char *shortrevisions,
 			    const char *shortonto, int num, unsigned flags)
 {
-	int edit_todo = !(shortrevisions && shortonto), res;
+	int res;
 	struct strbuf buf = STRBUF_INIT;
 
 	todo_list_to_strbuf(r, todo_list, &buf, num, flags);
-
-	if (flags & TODO_LIST_APPEND_TODO_HELP) {
-		int command_count = count_commands(todo_list);
-		if (!edit_todo) {
-			strbuf_addch(&buf, '\n');
-			strbuf_commented_addf(&buf, Q_("Rebase %s onto %s (%d command)",
-						       "Rebase %s onto %s (%d commands)",
-						       command_count),
-					      shortrevisions, shortonto, command_count);
-		}
-		append_todo_help(edit_todo, flags & TODO_LIST_KEEP_EMPTY, &buf);
-	}
+	if (flags & TODO_LIST_APPEND_TODO_HELP)
+		append_todo_help(flags & TODO_LIST_KEEP_EMPTY, count_commands(todo_list),
+				 shortrevisions, shortonto, &buf);
 
 	res = write_message(buf.buf, buf.len, file, 0);
 	strbuf_release(&buf);
Signature · 1 line
2.20.1
#186 lore raw

PATCH v8 16/18 rebase-interactive: rewrite edit_todo_list() to handle the initial edit

In reply to Alban Gruin

edit_todo_list() is changed to work on a todo_list, and to handle the initial edition of the todo list (ie. making a backup of the todo list).

It does not check for dropped commits yet, as todo_list_check() does not take the commits that have already been processed by the rebase (ie. the todo list is edited in the middle of a rebase session).

---
 builtin/rebase--interactive.c | 24 +++++++++++++++-
 rebase-interactive.c          | 53 +++++++++++++++++++----------------
 rebase-interactive.h          |  4 ++-
 sequencer.c                   |  3 +-
 sequencer.h                   |  1 +
 5 files changed, 57 insertions(+), 28 deletions(-)
builtin/rebase--interactive.c +23 -1
index ab2c6fcd99..b277239f21 100644
@@ -64,6 +64,28 @@ static int rearrange_squash_in_todo_file(void)
 	return 0;
 }
 
+static int edit_todo_file(unsigned flags)
+{
+	const char *todo_file = rebase_path_todo();
+	struct todo_list todo_list = TODO_LIST_INIT,
+		new_todo = 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);
+
+	strbuf_stripspace(&todo_list.buf, 1);
+	res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
+	if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
+					    NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
+		res = error_errno(_("could not write '%s'"), todo_file);
+
+	todo_list_release(&todo_list);
+	todo_list_release(&new_todo);
+
+	return res;
+}
+
 static int get_revision_ranges(const char *upstream, const char *onto,
 			       const char **head_hash,
 			       char **revisions, char **shortrevisions)
@@ -295,7 +317,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		break;
 	}
 	case EDIT_TODO:
-		ret = edit_todo_list(the_repository, flags);
+		ret = edit_todo_file(flags);
 		break;
 	case SHOW_CURRENT_PATCH: {
 		struct child_process cmd = CHILD_PROCESS_INIT;
rebase-interactive.c +29 -24

64 lines not on this page · raw message

rebase-interactive.h +3 -1
index 0e5925e3aa..44dbb06311 100644
@@ -8,7 +8,9 @@ struct todo_list;
 void append_todo_help(unsigned keep_empty, int command_count,
 		      const char *shortrevisions, const char *shortonto,
 		      struct strbuf *buf);
-int edit_todo_list(struct repository *r, unsigned flags);
+int edit_todo_list(struct repository *r, struct todo_list *todo_list,
+		   struct todo_list *new_todo, const char *shortrevisions,
+		   const char *shortonto, unsigned flags);
 int todo_list_check(struct todo_list *old_todo, struct todo_list *new_todo);
 
 #endif
sequencer.c +1 -2
index 8f3836c479..7d46f76a8b 100644
@@ -55,8 +55,7 @@ static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  * file and written to the tail of 'done'.
  */
 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
-static GIT_PATH_FUNC(rebase_path_todo_backup,
-		     "rebase-merge/git-rebase-todo.backup")
+GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
 
 /*
  * The rebase command lines that have already been processed. A line
sequencer.h +1 -0
index fb31a30d15..195891a267 100644
@@ -10,6 +10,7 @@ struct repository;
 const char *git_path_commit_editmsg(void);
 const char *git_path_seq_dir(void);
 const char *rebase_path_todo(void);
+const char *rebase_path_todo_backup(void);
 
 #define APPEND_SIGNOFF_DEDUP (1u << 0)
 
Signature · 1 line
2.20.1
#187 lore raw

PATCH v8 17/18 sequencer: use edit_todo_list() in complete_action()

In reply to Alban Gruin

This changes complete_action() to use edit_todo_list(), now that it can handle the initial edit of the todo list.

---
No changes since v7.

 sequencer.c | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)
sequencer.c +7 -14
index 7d46f76a8b..c56c3add1a 100644
@@ -4746,6 +4746,7 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 	struct todo_list new_todo = TODO_LIST_INIT;
 	struct strbuf *buf = &todo_list->buf;
 	struct object_id oid;
+	int res;
 
 	get_oid(onto, &oid);
 	shortonto = find_unique_abbrev(&oid, DEFAULT_ABBREV);
@@ -4770,24 +4771,16 @@ int complete_action(struct repository *r, struct replay_opts *opts, unsigned fla
 		return error(_("nothing to do"));
 	}
 
-	if (todo_list_write_to_file(r, todo_list, todo_file,
-				    shortrevisions, shortonto, -1,
-				    flags | TODO_LIST_SHORTEN_IDS | TODO_LIST_APPEND_TODO_HELP))
-		return error_errno(_("could not write '%s'"), todo_file);
-
-	if (copy_file(rebase_path_todo_backup(), todo_file, 0666))
-		return error(_("could not copy '%s' to '%s'."), todo_file,
-			     rebase_path_todo_backup());
-
-	if (launch_sequence_editor(todo_file, &new_todo.buf, NULL)) {
+	res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
+			     shortonto, flags);
+	if (res == -1)
+		return -1;
+	else if (res == -2) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 
 		return -1;
-	}
-
-	strbuf_stripspace(&new_todo.buf, 1);
-	if (new_todo.buf.len == 0) {
+	} else if (res == -3) {
 		apply_autostash(opts);
 		sequencer_remove_state(opts);
 		todo_list_release(&new_todo);
Signature · 1 line
2.20.1
#188 lore raw

PATCH v8 18/18 rebase--interactive: move transform_todo_file()

In reply to Alban Gruin

As transform_todo_file() is only needed inside of rebase--interactive.c for `rebase -p', it is moved there from sequencer.c.

The parameter r (repository) is dropped along the way.

---
New commit, but was a part of "rebase--interactive: move several functions to rebase--interactive.c" from the v7.

 builtin/rebase--interactive.c | 26 +++++++++++++++++++++++++-
 sequencer.c                   | 23 -----------------------
 sequencer.h                   |  1 -
 3 files changed, 25 insertions(+), 25 deletions(-)
builtin/rebase--interactive.c +25 -1
index b277239f21..4d9c1e62bb 100644
@@ -64,6 +64,30 @@ static int rearrange_squash_in_todo_file(void)
 	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();
@@ -330,7 +354,7 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 	}
 	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);
sequencer.c +0 -23
index c56c3add1a..2a0fcb1cce 100644
@@ -4632,29 +4632,6 @@ int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 	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"
sequencer.h +0 -1
index 195891a267..7cca49eff2 100644
@@ -143,7 +143,6 @@ int sequencer_remove_state(struct replay_opts *opts);
 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 			  const char **argv, 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);
Signature · 1 line
2.20.1
#189 lore raw
In reply to Alban Gruin

Hi Alban

Thanks for working on this. The range and inter diffs look fine, I think this is ready for next now.

Best Wishes

Phillip

Quoted 398 lines · Alban Gruin

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 <[email protected]>
      
     -    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 <[email protected]>
      
     @@ -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()