git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC PATCH 7/7] merge: teach --autostash option

From
Denton Liu <liu.denton@gmail.com>
Date
Dec 24, 2019, 10:05 UTC
Message-ID
<20191224100507.GB2743221@generichostname>
In-Reply-To
<nycvar.QRO.7.76.6.1910212103080.46@tvgsbejvaqbjf.bet>
Hi Dscho,
On Mon, Oct 21, 2019 at 09:10:09PM +0200, Johannes Schindelin wrote:
Show 15 quoted lines
> Hi Denton,
> 
> On Wed, 16 Oct 2019, Denton Liu wrote:
> 
> > In rebase, one can pass the `--autostash` option to cause the worktree
> > to be automatically stashed before continuing with the rebase. This
> > option is missing in merge, however.
> >
> > Implement the `--autostash` option and corresponding `merge.autoStash`
> > option in merge which stashes before merging and then pops after.
> >
> > Reported-by: Alban Gruin <alban.gruin@gmail.com>
> 
> Maybe "Suggested-by" would be more accurate, it is not like this feature
> request was a bug report...
Makes sense.
Show 53 quoted lines
> 
> > Signed-off-by: Denton Liu <liu.denton@gmail.com>
> > ---
> >  builtin/merge.c | 13 +++++++++++++
> >  builtin/pull.c  |  9 +++++----
> >  t/t5520-pull.sh |  8 --------
> >  3 files changed, 18 insertions(+), 12 deletions(-)
> >
> > diff --git a/builtin/merge.c b/builtin/merge.c
> > index 062e911441..d1a5eaad0d 100644
> > --- a/builtin/merge.c
> > +++ b/builtin/merge.c
> > @@ -40,6 +40,7 @@
> >  #include "branch.h"
> >  #include "commit-reach.h"
> >  #include "wt-status.h"
> > +#include "autostash.h"
> >
> >  #define DEFAULT_TWOHEAD (1<<0)
> >  #define DEFAULT_OCTOPUS (1<<1)
> > @@ -58,6 +59,8 @@ static const char * const builtin_merge_usage[] = {
> >  	NULL
> >  };
> >
> > +static GIT_PATH_FUNC(merge_autostash, "MERGE_AUTOSTASH")
> > +
> >  static int show_diffstat = 1, shortlog_len = -1, squash;
> >  static int option_commit = -1;
> >  static int option_edit = -1;
> > @@ -81,6 +84,7 @@ static int show_progress = -1;
> >  static int default_to_upstream = 1;
> >  static int signoff;
> >  static const char *sign_commit;
> > +static int autostash;
> >  static int no_verify;
> >
> >  static struct strategy all_strategy[] = {
> > @@ -285,6 +289,8 @@ static struct option builtin_merge_options[] = {
> >  	OPT_SET_INT(0, "progress", &show_progress, N_("force progress reporting"), 1),
> >  	{ OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
> >  	  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
> > +	OPT_BOOL(0, "autostash", &autostash,
> > +	      N_("automatically stash/stash pop before and after")),
> >  	OPT_BOOL(0, "overwrite-ignore", &overwrite_ignore, N_("update ignored files (default)")),
> >  	OPT_BOOL(0, "signoff", &signoff, N_("add Signed-off-by:")),
> >  	OPT_BOOL(0, "no-verify", &no_verify, N_("bypass pre-merge-commit and commit-msg hooks")),
> > @@ -440,6 +446,7 @@ static void finish(struct commit *head_commit,
> >  		strbuf_addf(&reflog_message, "%s: %s",
> >  			getenv("GIT_REFLOG_ACTION"), msg);
> >  	}
> > +	apply_autostash(merge_autostash());
> 
> Should this not be guarded by `if (autostash)`?

The apply_autostash() checks if an autostash file exists and then applies it if it does. As a result, we should be unconditionally calling apply_autostash().

I guess that an odd edge-case that might come up is that a user may run into a merge conflict, resolve the conflict, create a .git/MERGE_AUTOSTASH file and then, after they commit, the autostash file will be applied. Currently, rebase behaves the same way so I think it's safe to leave the behaviour as is. I don't think this is a common use-case that will come up anyway ;)

Show 67 quoted lines
> 
> >  	if (squash) {
> >  		squash_message(head_commit, remoteheads);
> >  	} else {
> > @@ -631,6 +638,9 @@ static int git_merge_config(const char *k, const char *v, void *cb)
> >  	} else if (!strcmp(k, "commit.gpgsign")) {
> >  		sign_commit = git_config_bool(k, v) ? "" : NULL;
> >  		return 0;
> > +	} else if (!strcmp(k, "merge.autostash")) {
> > +		autostash = git_config_bool(k, v);
> > +		return 0;
> >  	}
> >
> >  	status = fmt_merge_msg_config(k, v, cb);
> > @@ -724,6 +734,8 @@ static int try_merge_strategy(const char *strategy, struct commit_list *common,
> >  		for (j = common; j; j = j->next)
> >  			commit_list_insert(j->item, &reversed);
> >
> > +		if (autostash)
> > +			perform_autostash(merge_autostash());
> >  		hold_locked_index(&lock, LOCK_DIE_ON_ERROR);
> >  		clean = merge_recursive(&o, head,
> >  				remoteheads->item, reversed, &result);
> > @@ -1288,6 +1300,7 @@ int cmd_merge(int argc, const char **argv, const char *prefix)
> >
> >  		/* Invoke 'git reset --merge' */
> >  		ret = cmd_reset(nargc, nargv, prefix);
> > +		apply_autostash(merge_autostash());
> 
> Again, this should be guarded by `if (autostash)`, methinks.
> 
> >  		goto done;
> >  	}
> >
> > diff --git a/builtin/pull.c b/builtin/pull.c
> > index d25ff13a60..ee186781ae 100644
> > --- a/builtin/pull.c
> > +++ b/builtin/pull.c
> > @@ -183,7 +183,7 @@ static struct option pull_options[] = {
> >  		N_("verify that the named commit has a valid GPG signature"),
> >  		PARSE_OPT_NOARG),
> >  	OPT_BOOL(0, "autostash", &opt_autostash,
> > -		N_("automatically stash/stash pop before and after rebase")),
> > +		N_("automatically stash/stash pop before and after")),
> 
> Makes sense; this is now shared between the rebase and the merge modes.
> 
> >  	OPT_PASSTHRU_ARGV('s', "strategy", &opt_strategies, N_("strategy"),
> >  		N_("merge strategy to use"),
> >  		0),
> > @@ -671,6 +671,10 @@ static int run_merge(void)
> >  	argv_array_pushv(&args, opt_strategy_opts.argv);
> >  	if (opt_gpg_sign)
> >  		argv_array_push(&args, opt_gpg_sign);
> > +	if (opt_autostash == 0)
> > +		argv_array_push(&args, "--no-autostash");
> > +	else if (opt_autostash == 1)
> > +		argv_array_push(&args, "--autostash");
> 
> Or shorter:
> 
> 	argv_array_pushf(&args, "%s-autostash", opt_autostash ? "-" : "--no");
> 
> Ah, but that would mishandle `-1`. I bet I will be puzzled by this
> again. Maybe it would make sense to mention in a code comment that it
> can be `-1` in which case we leave it to `rebase` to use the config
> settings to determine whether or not to autostash.

I copied this over from the rebase case. I'll add a comment there as well.

Show 33 quoted lines
> 
> >  	if (opt_allow_unrelated_histories > 0)
> >  		argv_array_push(&args, "--allow-unrelated-histories");
> >
> > @@ -918,9 +922,6 @@ int cmd_pull(int argc, const char **argv, const char *prefix)
> >  	if (get_oid("HEAD", &orig_head))
> >  		oidclr(&orig_head);
> >
> > -	if (!opt_rebase && opt_autostash != -1)
> > -		die(_("--[no-]autostash option is only valid with --rebase."));
> > -
> >  	autostash = config_autostash;
> >  	if (opt_rebase) {
> >  		if (opt_autostash != -1)
> > diff --git a/t/t5520-pull.sh b/t/t5520-pull.sh
> > index cf4cc32fd0..75f162495a 100755
> > --- a/t/t5520-pull.sh
> > +++ b/t/t5520-pull.sh
> > @@ -365,14 +365,6 @@ test_expect_success 'pull --rebase --no-autostash & rebase.autostash unset' '
> >  	test_pull_autostash_fail --rebase --no-autostash
> >  '
> >
> > -for i in --autostash --no-autostash
> > -do
> > -	test_expect_success "pull $i (without --rebase) is illegal" '
> > -		test_must_fail git pull $i . copy 2>err &&
> > -		test_i18ngrep "only valid with --rebase" err
> > -	'
> > -done
> > -
> 
> Nice!
> Dscho
Thanks,
Denton
Show 8 quoted lines
> 
> >  test_expect_success 'pull.rebase' '
> >  	git reset --hard before-rebase &&
> >  	test_config pull.rebase true &&
> > --
> > 2.23.0.897.g0a19638b1e
> >
> >
Previous: Johannes SchindelinNext: Denton Liu
Message 25 of 152 in “merge: learn --autostash”
  1. 0/7 merge: learn --autostashDenton Liu, Oct 16, 2019
  2. 1/7 Makefile: alphabetically sort += listsDenton Liu, Oct 16, 2019
  3. Junio C HamanoOct 17, 2019
  4. Johannes SchindelinOct 21, 2019
  5. Denton LiuOct 21, 2019
  6. Johannes SchindelinOct 22, 2019
  7. Junio C HamanoOct 21, 2019
  8. Jeff KingOct 21, 2019
  9. Junio C HamanoOct 22, 2019
  10. 2/7 autostash: extract read_one() from rebaseDenton Liu, Oct 16, 2019
  11. Phillip WoodOct 18, 2019
  12. Johannes SchindelinOct 21, 2019
  13. 3/7 autostash: extract apply_autostash() from rebaseDenton Liu, Oct 16, 2019
  14. 4/7 autostash: extract reset_head() from rebaseDenton Liu, Oct 16, 2019
  15. Phillip WoodOct 18, 2019
  16. Johannes SchindelinOct 21, 2019
  17. 5/7 autostash: extract perform_autostash() from rebaseDenton Liu, Oct 16, 2019
  18. Johannes SchindelinOct 21, 2019
  19. 6/7 autostash.c: undefine USE_THE_INDEX_COMPATIBILITY_MACROSDenton Liu, Oct 16, 2019
  20. Phillip WoodOct 18, 2019
  21. 7/7 merge: teach --autostash optionDenton Liu, Oct 16, 2019
  22. Phillip WoodOct 18, 2019
  23. Denton LiuDec 24, 2019
  24. Johannes SchindelinOct 21, 2019
  25. Denton LiuDec 24, 2019
  26. Denton LiuDec 24, 2019
  27. 00/17 merge: learn --autostashDenton Liu, Dec 24, 2019
  28. 03/17 sequencer: use file strbuf for read_oneliner()Denton Liu, Dec 24, 2019
  29. 02/17 t7600: use test_write_lines()Denton Liu, Dec 24, 2019
  30. 01/17 Makefile: alphabetically sort += listsDenton Liu, Dec 24, 2019
  31. Junio C HamanoDec 30, 2019
  32. 06/17 rebase: use read_oneliner()Denton Liu, Dec 24, 2019
  33. 04/17 sequencer: configurably warn on non-existent filesDenton Liu, Dec 24, 2019
  34. Junio C HamanoDec 26, 2019
  35. 07/17 sequencer: make apply_rebase() accept a pathDenton Liu, Dec 24, 2019
  36. 08/17 rebase: use apply_autostash() from sequencer.cDenton Liu, Dec 24, 2019
  37. 05/17 sequencer: make read_oneliner() externDenton Liu, Dec 24, 2019
  38. 10/17 reset: extract reset_head() from rebaseDenton Liu, Dec 24, 2019
  39. 12/17 rebase: generify create_autostash()Denton Liu, Dec 24, 2019
  40. 13/17 sequencer: extract perform_autostash() from rebaseDenton Liu, Dec 24, 2019
  41. 09/17 rebase: generify reset_head()Denton Liu, Dec 24, 2019
  42. 11/17 rebase: extract create_autostash()Denton Liu, Dec 24, 2019
  43. 17/17 pull: pass --autostash to mergeDenton Liu, Dec 24, 2019
  44. 14/17 sequencer: unlink autostash in apply_autostash()Denton Liu, Dec 24, 2019
  45. 16/17 t5520: make test_pull_autostash() accept expect_parent_numDenton Liu, Dec 24, 2019
  46. 15/17 merge: teach --autostash optionDenton Liu, Dec 24, 2019
  47. Junio C HamanoDec 30, 2019
  48. Phillip WoodDec 31, 2019
  49. Denton LiuJan 8, 2020
  50. Phillip WoodJan 10, 2020
  51. Denton LiuJan 15, 2020
  52. Denton LiuJan 1, 2020
  53. 00/19 merge: learn --autostashDenton Liu, Mar 21, 2020
  54. 02/19 t7600: use test_write_lines()Denton Liu, Mar 21, 2020
  55. 01/19 Makefile: ASCII-sort += listsDenton Liu, Mar 21, 2020
  56. 03/19 sequencer: use file strbuf for read_oneliner()Denton Liu, Mar 21, 2020
  57. Phillip WoodApr 2, 2020
  58. 04/19 sequencer: make read_oneliner() accept flagsDenton Liu, Mar 21, 2020
  59. 05/19 sequencer: configurably warn on non-existent filesDenton Liu, Mar 21, 2020
  60. Phillip WoodApr 2, 2020
  61. 07/19 rebase: use read_oneliner()Denton Liu, Mar 21, 2020
  62. Phillip WoodApr 2, 2020
  63. 06/19 sequencer: make read_oneliner() externDenton Liu, Mar 21, 2020
  64. 08/19 sequencer: make apply_rebase() accept a pathDenton Liu, Mar 21, 2020
  65. 09/19 rebase: use apply_autostash() from sequencer.cDenton Liu, Mar 21, 2020
  66. Phillip WoodApr 2, 2020
  67. 10/19 rebase: generify reset_head()Denton Liu, Mar 21, 2020
  68. 11/19 reset: extract reset_head() from rebaseDenton Liu, Mar 21, 2020
  69. Phillip WoodApr 2, 2020
  70. 12/19 rebase: extract create_autostash()Denton Liu, Mar 21, 2020
  71. 13/19 rebase: generify create_autostash()Denton Liu, Mar 21, 2020
  72. 14/19 sequencer: extract perform_autostash() from rebaseDenton Liu, Mar 21, 2020
  73. 15/19 sequencer: unlink autostash in apply_autostash()Denton Liu, Mar 21, 2020
  74. 16/19 sequencer: implement save_autostash()Denton Liu, Mar 21, 2020
  75. Phillip WoodApr 2, 2020
  76. 18/19 t5520: make test_pull_autostash() accept expect_parent_numDenton Liu, Mar 21, 2020
  77. 17/19 merge: teach --autostash optionDenton Liu, Mar 21, 2020
  78. Phillip WoodApr 2, 2020
  79. Denton LiuApr 3, 2020
  80. Denton LiuApr 3, 2020
  81. Phillip WoodApr 3, 2020
  82. Denton LiuApr 3, 2020
  83. Phillip WoodApr 3, 2020
  84. Denton LiuApr 3, 2020
  85. 19/19 pull: pass --autostash to mergeDenton Liu, Mar 21, 2020
  86. Phillip WoodApr 2, 2020
  87. 00/23 merge: learn --autostashDenton Liu, Apr 4, 2020
  88. 02/23 t7600: use test_write_lines()Denton Liu, Apr 4, 2020
  89. 03/23 sequencer: stop leaking bufDenton Liu, Apr 4, 2020
  90. Junio C HamanoApr 5, 2020
  91. Junio C HamanoApr 5, 2020
  92. Denton LiuApr 5, 2020
  93. 05/23 sequencer: make file exists check more efficientDenton Liu, Apr 4, 2020
  94. 04/23 sequencer: reuse strbuf_trim() in read_oneliner()Denton Liu, Apr 4, 2020
  95. Junio C HamanoApr 5, 2020
  96. Denton LiuApr 6, 2020
  97. Phillip WoodApr 6, 2020
  98. Phillip WoodApr 6, 2020
  99. Denton LiuApr 7, 2020
  100. 07/23 sequencer: configurably warn on non-existent filesDenton Liu, Apr 4, 2020
  101. Phillip WoodApr 6, 2020
  102. 09/23 rebase: use read_oneliner()Denton Liu, Apr 4, 2020
  103. 01/23 Makefile: ASCII-sort += listsDenton Liu, Apr 4, 2020
  104. 08/23 sequencer: make read_oneliner() externDenton Liu, Apr 4, 2020
  105. 12/23 rebase: use apply_autostash() from sequencer.cDenton Liu, Apr 4, 2020
  106. 11/23 sequencer: rename stash_sha1 to stash_oidDenton Liu, Apr 4, 2020
  107. 15/23 rebase: extract create_autostash()Denton Liu, Apr 4, 2020
  108. 13/23 rebase: generify reset_head()Denton Liu, Apr 4, 2020
  109. 16/23 rebase: generify create_autostash()Denton Liu, Apr 4, 2020
  110. 17/23 sequencer: extract perform_autostash() from rebaseDenton Liu, Apr 4, 2020
  111. 18/23 sequencer: unlink autostash in apply_autostash()Denton Liu, Apr 4, 2020
  112. 20/23 sequencer: implement apply_autostash_oid()Denton Liu, Apr 4, 2020
  113. 14/23 reset: extract reset_head() from rebaseDenton Liu, Apr 4, 2020
  114. 22/23 t5520: make test_pull_autostash() accept expect_parent_numDenton Liu, Apr 4, 2020
  115. 19/23 sequencer: implement save_autostash()Denton Liu, Apr 4, 2020
  116. Phillip WoodApr 6, 2020
  117. 23/23 pull: pass --autostash to mergeDenton Liu, Apr 4, 2020
  118. 10/23 sequencer: make apply_rebase() accept a pathDenton Liu, Apr 4, 2020
  119. Phillip WoodApr 6, 2020
  120. 21/23 merge: teach --autostash optionDenton Liu, Apr 4, 2020
  121. Phillip WoodApr 6, 2020
  122. Denton LiuApr 7, 2020
  123. Phillip WoodApr 7, 2020
  124. 06/23 sequencer: make read_oneliner() accept flagsDenton Liu, Apr 4, 2020
  125. 00/22 merge: learn --autostashDenton Liu, Apr 7, 2020
  126. 02/22 t7600: use test_write_lines()Denton Liu, Apr 7, 2020
  127. 01/22 Makefile: ASCII-sort += listsDenton Liu, Apr 7, 2020
  128. 04/22 sequencer: make file exists check more efficientDenton Liu, Apr 7, 2020
  129. Junio C HamanoApr 8, 2020
  130. 03/22 sequencer: stop leaking bufDenton Liu, Apr 7, 2020
  131. 05/22 sequencer: make read_oneliner() accept flagsDenton Liu, Apr 7, 2020
  132. Junio C HamanoApr 8, 2020
  133. 06/22 sequencer: configurably warn on non-existent filesDenton Liu, Apr 7, 2020
  134. 07/22 sequencer: make read_oneliner() externDenton Liu, Apr 7, 2020
  135. 08/22 rebase: use read_oneliner()Denton Liu, Apr 7, 2020
  136. Junio C HamanoApr 8, 2020
  137. 11/22 rebase: use apply_autostash() from sequencer.cDenton Liu, Apr 7, 2020
  138. 12/22 rebase: generify reset_head()Denton Liu, Apr 7, 2020
  139. 14/22 rebase: extract create_autostash()Denton Liu, Apr 7, 2020
  140. 15/22 rebase: generify create_autostash()Denton Liu, Apr 7, 2020
  141. 13/22 reset: extract reset_head() from rebaseDenton Liu, Apr 7, 2020
  142. 10/22 sequencer: rename stash_sha1 to stash_oidDenton Liu, Apr 7, 2020
  143. 09/22 sequencer: make apply_autostash() accept a pathDenton Liu, Apr 7, 2020
  144. 16/22 sequencer: extract perform_autostash() from rebaseDenton Liu, Apr 7, 2020
  145. 17/22 sequencer: unlink autostash in apply_autostash()Denton Liu, Apr 7, 2020
  146. 21/22 t5520: make test_pull_autostash() accept expect_parent_numDenton Liu, Apr 7, 2020
  147. 18/22 sequencer: implement save_autostash()Denton Liu, Apr 7, 2020
  148. 19/22 sequencer: implement apply_autostash_oid()Denton Liu, Apr 7, 2020
  149. 20/22 merge: teach --autostash optionDenton Liu, Apr 7, 2020
  150. 22/22 pull: pass --autostash to mergeDenton Liu, Apr 7, 2020
  151. Phillip WoodApr 10, 2020
  152. Junio C HamanoApr 10, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.