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.
This option is useful when a developer has some local changes on a topic
branch but they realize that their work depends on another branch.
Previously, they had to run something like
git fetch ...
git stash push
git merge FETCH_HEAD
git stash pop
but now, that is reduced to
git fetch ...
git merge --autostash FETCH_HEAD
When an autostash is generated, it is automatically reapplied to the
worktree only in three explicit situations:
1. An incomplete merge is commit using `git commit`.
2. A merge completes successfully.
3. A merge is aborted using `git merge --abort`.
In all other situations where the merge state is removed using
remove_merge_branch_state() such as aborting a merge via
`git reset --hard`, the autostash is saved into the stash reflog
instead keeping the worktree clean.
Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Suggested-by: Alban Gruin <alban.gruin@gmail.com>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
@ -94,7 +94,8 @@ will be appended to the specified message.
@@ -94,7 +94,8 @@ will be appended to the specified message.
--abort::
Abort the current conflict resolution process, and
try to reconstruct the pre-merge state.
try to reconstruct the pre-merge state. If an autostash entry is
present, apply it to the worktree.
+
If there were uncommitted worktree changes present when the merge
started, 'git merge --abort' will in some cases be unable to
@ -102,11 +103,15 @@ reconstruct these changes. It is therefore recommended to always
@@ -102,11 +103,15 @@ reconstruct these changes. It is therefore recommended to always
commit or stash your changes before running 'git merge'.
+
'git merge --abort' is equivalent to 'git reset --merge' when
`MERGE_HEAD` is present.
`MERGE_HEAD` is present unless `MERGE_AUTOSTASH` is also present in
which case 'git merge --abort' applies the stash entry to the worktree
whereas 'git reset --merge' will save the stashed changes in the stash
reflog.
--quit::
Forget about the current merge in progress. Leave the index
and the working tree as-is.
and the working tree as-is. If `MERGE_AUTOSTASH` is present, the
stash entry will be saved to the stash reflog.
--continue::
After a 'git merge' stops due to conflicts you can conclude the
#define OPT_CLEANUP(v) OPT_STRING(0, "cleanup", v, N_("mode"), N_("how to strip spaces and #comments from message"))
#define OPT_PATHSPEC_FROM_FILE(v) OPT_FILENAME(0, "pathspec-from-file", v, N_("read pathspec from file"))
#define OPT_PATHSPEC_FILE_NUL(v) OPT_BOOL(0, "pathspec-file-nul", v, N_("with --pathspec-from-file, pathspec elements are separated with NUL character"))
#define OPT_AUTOSTASH(v) OPT_BOOL(0, "autostash", v, N_("automatically stash/stash pop before and after"))
@ -675,6 +679,134 @@ test_expect_success 'refresh the index before merging' '
@@ -675,6 +679,134 @@ test_expect_success 'refresh the index before merging' '
git merge c3
'
test_expect_success 'merge with --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git merge --autostash c2 2>err &&
test_i18ngrep "Applied autostash." err &&
git show HEAD:file >merge-result &&
test_cmp result.1-5 merge-result &&
test_cmp result.1-5-9 file
'
test_expect_success 'merge with merge.autoStash' '
test_config merge.autoStash true &&
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git merge c2 2>err &&
test_i18ngrep "Applied autostash." err &&
git show HEAD:file >merge-result &&
test_cmp result.1-5 merge-result &&
test_cmp result.1-5-9 file
'
test_expect_success 'fast-forward merge with --autostash' '
git reset --hard c0 &&
git merge-file file file.orig file.5 &&
git merge --autostash c1 2>err &&
test_i18ngrep "Applied autostash." err &&
test_cmp result.1-5 file
'
test_expect_success 'octopus merge with --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.3 &&
git merge --autostash c2 c3 2>err &&
test_i18ngrep "Applied autostash." err &&
git show HEAD:file >merge-result &&
test_cmp result.1-5-9 merge-result &&
test_cmp result.1-3-5-9 file
'
test_expect_success 'conflicted merge with --autostash, --abort restores stash' '
git reset --hard c3 &&
cp file.1 file &&
test_must_fail git merge --autostash c7 &&
git merge --abort 2>err &&
test_i18ngrep "Applied autostash." err &&
test_cmp file.1 file
'
test_expect_success 'completed merge (git commit) with --no-commit and --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git diff >expect &&
git merge --no-commit --autostash c2 &&
git stash show -p MERGE_AUTOSTASH >actual &&
test_cmp expect actual &&
git commit 2>err &&
test_i18ngrep "Applied autostash." err &&
git show HEAD:file >merge-result &&
test_cmp result.1-5 merge-result &&
test_cmp result.1-5-9 file
'
test_expect_success 'completed merge (git merge --continue) with --no-commit and --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git diff >expect &&
git merge --no-commit --autostash c2 &&
git stash show -p MERGE_AUTOSTASH >actual &&
test_cmp expect actual &&
git merge --continue 2>err &&
test_i18ngrep "Applied autostash." err &&
git show HEAD:file >merge-result &&
test_cmp result.1-5 merge-result &&
test_cmp result.1-5-9 file
'
test_expect_success 'aborted merge (merge --abort) with --no-commit and --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git diff >expect &&
git merge --no-commit --autostash c2 &&
git stash show -p MERGE_AUTOSTASH >actual &&
test_cmp expect actual &&
git merge --abort 2>err &&
test_i18ngrep "Applied autostash." err &&
git diff >actual &&
test_cmp expect actual
'
test_expect_success 'aborted merge (reset --hard) with --no-commit and --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git diff >expect &&
git merge --no-commit --autostash c2 &&
git stash show -p MERGE_AUTOSTASH >actual &&
test_cmp expect actual &&
git reset --hard 2>err &&
test_i18ngrep "Autostash exists; creating a new stash entry." err &&
git diff --exit-code
'
test_expect_success 'quit merge with --no-commit and --autostash' '
git reset --hard c1 &&
git merge-file file file.orig file.9 &&
git diff >expect &&
git merge --no-commit --autostash c2 &&
git stash show -p MERGE_AUTOSTASH >actual &&
test_cmp expect actual &&
git diff HEAD >expect &&
git merge --quit 2>err &&
test_i18ngrep "Autostash exists; creating a new stash entry." err &&
git diff HEAD >actual &&
test_cmp expect actual
'
test_expect_success 'merge with conflicted --autostash changes' '
Denton Liu
5 years ago
committed by