Web lists-archives.com

Re: [PATCH 1/2] commit/reset: try to clean up sequencer state




On 01/04/2019 11:09, Duy Nguyen wrote:
On Fri, Mar 29, 2019 at 11:32 PM Phillip Wood <phillip.wood123@xxxxxxxxx> wrote:

From: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>

When cherry-picking or reverting a sequence of commits and if the final
pick/revert has conflicts and the user uses `git commit` to commit the
conflict resolution and does not run `git cherry-pick --continue` then
the sequencer state is left behind. This can cause problems later. In my
case I cherry-picked a sequence of commits the last one of which I
committed with `git commit` after resolving some conflicts, then a while
later, on a different branch I aborted a revert which rewound my HEAD to
the end of the cherry-pick sequence on the previous branch. Avoid this
potential problem by removing the sequencer state if we're committing or
resetting the final pick in a sequence.

Signed-off-by: Phillip Wood <phillip.wood@xxxxxxxxxxxxx>
---
  branch.c                        |  7 +++++--
  builtin/commit.c                |  7 +++++--
  sequencer.c                     | 23 +++++++++++++++++++++++
  sequencer.h                     |  1 +
  t/t3507-cherry-pick-conflict.sh | 19 +++++++++++++++++++
  5 files changed, 53 insertions(+), 4 deletions(-)

diff --git a/branch.c b/branch.c
index 28b81a7e02..9ed60081c1 100644
--- a/branch.c
+++ b/branch.c
@@ -5,6 +5,7 @@
  #include "refs.h"
  #include "refspec.h"
  #include "remote.h"
+#include "sequencer.h"
  #include "commit.h"
  #include "worktree.h"

@@ -339,8 +340,10 @@ void create_branch(struct repository *r,

  void remove_branch_state(struct repository *r)

This function is also called in git-am, git-rebase and git-checkout.
While the first two should not be affected, git-checkout can be
executed while we're in the middle of a cherry-pick or revert. I guess
that's ok because git-checkout is basically the same as git-reset in
this case?

Yes that's right

  {
-       unlink(git_path_cherry_pick_head(r));
-       unlink(git_path_revert_head(r));
+       if (!unlink(git_path_cherry_pick_head(r)))
+               sequencer_post_commit_cleanup();
+       if (!unlink(git_path_revert_head(r)))
+               sequencer_post_commit_cleanup();
         unlink(git_path_merge_head(r));
         unlink(git_path_merge_rr(r));
         unlink(git_path_merge_msg(r));
diff --git a/builtin/commit.c b/builtin/commit.c
index 2986553d5f..422b7d62a5 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -1657,8 +1657,10 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
                 die("%s", err.buf);
         }

-       unlink(git_path_cherry_pick_head(the_repository));
-       unlink(git_path_revert_head(the_repository));
+       if (!unlink(git_path_cherry_pick_head(the_repository)))
+               sequencer_post_commit_cleanup();
+       if (!unlink(git_path_revert_head(the_repository)))
+               sequencer_post_commit_cleanup();
         unlink(git_path_merge_head(the_repository));
         unlink(git_path_merge_msg(the_repository));
         unlink(git_path_merge_mode(the_repository));
@@ -1678,6 +1680,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
         if (amend && !no_post_rewrite) {
                 commit_post_rewrite(the_repository, current_head, &oid);
         }
+
         if (!quiet) {
                 unsigned int flags = 0;

diff --git a/sequencer.c b/sequencer.c
index 0db410d590..028699209f 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -2220,6 +2220,29 @@ static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
         return len;
  }

+void sequencer_post_commit_cleanup(void)
+{
+       struct replay_opts opts = REPLAY_OPTS_INIT;
+       struct strbuf buf = STRBUF_INIT;
+       const char *eol;
+       const char *todo_path = git_path_todo_file();
+
+       if (strbuf_read_file(&buf, todo_path, 0) < 0) {
+               if (errno == ENOENT) {
+                       return;
+               } else {
+                       error_errno("unable to open '%s'", todo_path);

_() the string to make it translatable.

Well spotted, thanks

+                       return;
+               }
+       }
+       /* If there is only one line then we are done */
+       eol = strchr(buf.buf, '\n');
+       if (!eol || !eol[1])
+               sequencer_remove_state(&opts);

Should we say something to let the user know cherry-pick/revert is
finished? (unless --quiet is specified)

I'd not thought of that, at the moment we don't say anything about removing CHERRY_PICK_HEAD etc when they are removed by reset or checkout, I'm not sure this is much different to those cases - but maybe they should be printing some feedback as well.

Best Wishes

Phillip

+
+       strbuf_release(&buf);
+}
+
  static int read_populate_todo(struct repository *r,
                               struct todo_list *todo_list,
                               struct replay_opts *opts)