Git uses the `rebase.autoStash` option to decide if git-pull is allowed
when the working tree has uncommitted changes. However, since the
documentation does not explicitly state this, users may find it difficult
to associate `rebase.autoStash` with the git-pull command. Add
`pull.autoStash` option along with its documentation.
`pull.autoStash` provides the same functionality as `rebase.autoStash`
but is more user-friendly because its prefix clearly associates it
with git-pull commands. Additionally, when both options are set,
`pull.autoStash` takes precedence and overrides the value of
`rebase.autoStash`.
Signed-off-by: Lidong Yan <yldhome2d2@xxxxxxxxx>
---
Documentation/config/pull.adoc | 9 +++++++++
builtin/pull.c | 10 +++++++---
2 files changed, 16 insertions(+), 3 deletions(-)
diff --git a/Documentation/config/pull.adoc b/Documentation/config/pull.adoc
index 9349e09261..da9686dbd2 100644
--- a/Documentation/config/pull.adoc
+++ b/Documentation/config/pull.adoc
@@ -13,6 +13,15 @@ pull.rebase::
of merging the default branch from the default remote when "git
pull" is run. See "branch.<name>.rebase" for setting this on a
per-branch basis.
+
+pull.autoStash::
+ When true, Git will automatically perform a `git stash` before the
+ operation and then restore the local changes with `git stash pop`
+ after the merge or rebase is complete. This means that you can run
+ pull on a dirty worktree. Noticed that `rebase.autoStash` provides
+ the same functionality, but `pull.autoStash` overrides its behavior
+ when both are set. This option can be overridden by the `--no-autostash`
+ and `--autostash` options of linkgit:git-pull[1]. Defaults to false.
+
When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase'
so that the local merge commits are included in the rebase (see
diff --git a/builtin/pull.c b/builtin/pull.c
index c593f324fe..dfc3d4656b 100644
--- a/builtin/pull.c
+++ b/builtin/pull.c
@@ -90,7 +90,8 @@ static char *opt_ff;
static const char *opt_verify_signatures;
static const char *opt_verify;
static int opt_autostash = -1;
-static int config_autostash;
+static int config_rebase_autostash;
+static int config_pull_autostash = -1;
static int check_trust_level = 1;
static struct strvec opt_strategies = STRVEC_INIT;
static struct strvec opt_strategy_opts = STRVEC_INIT;
@@ -367,7 +368,10 @@ static int git_pull_config(const char *var, const char *value,
const struct config_context *ctx, void *cb)
{
if (!strcmp(var, "rebase.autostash")) {
- config_autostash = git_config_bool(var, value);
+ config_rebase_autostash = git_config_bool(var, value);
+ return 0;
+ } else if (!strcmp(var, "pull.autostash")) {
+ config_pull_autostash = git_config_bool(var, value);
return 0;
} else if (!strcmp(var, "submodule.recurse")) {
recurse_submodules = git_config_bool(var, value) ?
@@ -1052,7 +1056,7 @@ int cmd_pull(int argc,
if (opt_rebase) {
if (opt_autostash == -1)
- opt_autostash = config_autostash;
+ opt_autostash = config_pull_autostash == -1 ? config_rebase_autostash : config_pull_autostash;
if (is_null_oid(&orig_head) && !is_index_unborn(the_repository->index))
die(_("Updating an unborn branch with changes added to the index."));
--
2.39.5 (Apple Git-154)
