[GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[Mehul Jain]

With this patch, git pull --rebase will understand --no-autostash command line flag.
This flag will override "rebase.autostash" configuration(if set) and leads to a
failure if current working directory is dirty. If "rebase.autostash" is not configured
and no flag is passed then by default command will die if directory is to be dirty, before
even calling rebase.

I am also thinking of adding a "--autostash" flag for git pull --rebase, which will
override "rebase.autostash" configuration(if set false) and will pass --autostash to
git rebase. I would like to know your opinion on this option. 

Thanks! 

Mehul Jain (1):
  Add --no-autostash flag to git pull --rebase

 builtin/pull.c          | 12 ++++++++----
 t/t5520-pull.sh         |  8 ++++++++
 t/t5521-pull-options.sh | 24 ++++++++++++++++++++++++
 3 files changed, 40 insertions(+), 4 deletions(-)

-- 
2.7.1.340.g69eb491.dirty

[PATCH] Add --no-autostash flag to git pull --rebase

[Mehul Jain]

git pull --rebase now understand --no-autostash flag. If directory is found
to be dirty then command will die. This flag override "rebase.autostash" 
configuration(if set). If this flag is not passed in command line then
default behaviour is choosen, given by "rebase.autostash"(if "rebase.autostash"
is not set then git pull --rebase will die if directory is dirty).

Signed-off-by: Mehul Jain <mehul.jain2029@gmail.com>
---
 builtin/pull.c          | 12 ++++++++----
 t/t5520-pull.sh         |  8 ++++++++
 t/t5521-pull-options.sh | 24 ++++++++++++++++++++++++
 3 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/builtin/pull.c b/builtin/pull.c
index 10eff03..9d1a3d0 100644
--- a/builtin/pull.c
+++ b/builtin/pull.c
@@ -85,6 +85,7 @@ static char *opt_squash;
 static char *opt_commit;
 static char *opt_edit;
 static char *opt_ff;
+static int opt_autostash = -1;
 static char *opt_verify_signatures;
 static struct argv_array opt_strategies = ARGV_ARRAY_INIT;
 static struct argv_array opt_strategy_opts = ARGV_ARRAY_INIT;
@@ -146,6 +147,8 @@ static struct option pull_options[] = {
 	OPT_PASSTHRU(0, "ff-only", &opt_ff, NULL,
 		N_("abort if fast-forward is not possible"),
 		PARSE_OPT_NOARG | PARSE_OPT_NONEG),
+	OPT_COLOR_FLAG(0,"autostash",&opt_autostash,
+		N_("abort if tree is dirty")),
 	OPT_PASSTHRU(0, "verify-signatures", &opt_verify_signatures, NULL,
 		N_("verify that the named commit has a valid GPG signature"),
 		PARSE_OPT_NOARG),
@@ -835,13 +838,14 @@ int cmd_pull(int argc, const char **argv, const char *prefix)
 		hashclr(orig_head);
 
 	if (opt_rebase) {
-		int autostash = 0;
-
 		if (is_null_sha1(orig_head) && !is_cache_unborn())
 			die(_("Updating an unborn branch with changes added to the index."));
 
-		git_config_get_bool("rebase.autostash", &autostash);
-		if (!autostash)
+		if(opt_autostash < 0)
+			if(git_config_get_bool("rebase.autostash",&opt_autostash))
+				opt_autostash = 0;
+
+		if (!opt_autostash)
 			die_on_unclean_work_tree(prefix);
 
 		if (get_rebase_fork_point(rebase_fork_point, repo, *refspecs))
diff --git a/t/t5520-pull.sh b/t/t5520-pull.sh
index c952d5e..512d3bf 100755
--- a/t/t5520-pull.sh
+++ b/t/t5520-pull.sh
@@ -245,6 +245,14 @@ test_expect_success '--rebase fails with multiple branches' '
 	test modified = "$(git show HEAD:file)"
 '
 
+test_expect_success '--rebase --no-autostash fails with dirty working directory' '
+	test_config rebase.autostash true &&
+	git reset --hard before-rebase &&
+	echo dirty >new_file &&
+	git add new_file &&
+	test_must_fail git pull --rebase --no-autostash . copy
+'
+
 test_expect_success 'pull --rebase succeeds with dirty working directory and rebase.autostash set' '
 	test_config rebase.autostash true &&
 	git reset --hard before-rebase &&
diff --git a/t/t5521-pull-options.sh b/t/t5521-pull-options.sh
index 18372ca..22ff5d7 100755
--- a/t/t5521-pull-options.sh
+++ b/t/t5521-pull-options.sh
@@ -62,6 +62,30 @@ test_expect_success 'git pull -v --rebase' '
 	test_must_be_empty out)
 '
 
+test_expect_success 'git pull --rebase --no-autostash' '
+	mkdir clonedrbnas &&
+	(cd clonedrbnas  && git init &&
+	git pull --rebase --no-autostash "../parent" >out 2>err &&
+	test -s err &&
+	test_must_be_empty out)
+'
+
+test_expect_success 'git pull -q --rebase --no-autostash' '
+	mkdir clonedqrbnas &&
+	(cd clonedqrbnas  && git init &&
+	git pull -q --rebase --no-autostash "../parent" >out 2>err &&
+	test_must_be_empty err &&
+	test_must_be_empty out)
+'
+
+test_expect_success 'git pull -v --rebase --no-autostash' '
+	mkdir clonedvrbnas &&
+	(cd clonedvrbnas && git init &&
+	git pull -v --rebase --no-autostash "../parent" >out 2>err &&
+	test -s err &&
+	test_must_be_empty out)
+'
+
 test_expect_success 'git pull -v -q' '
 	mkdir clonedvq &&
 	(cd clonedvq && git init &&
-- 
2.7.1.340.g69eb491.dirty

Re: [GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[Paul Tan]

On Fri, Feb 26, 2016 at 7:23 PM, Mehul Jain <mehul.jain2029@gmail.com> wrote:
> With this patch, git pull --rebase will understand --no-autostash command line flag.
> This flag will override "rebase.autostash" configuration(if set) and leads to a
> failure if current working directory is dirty. If "rebase.autostash" is not configured
> and no flag is passed then by default command will die if directory is to be dirty, before
> even calling rebase.
>
> I am also thinking of adding a "--autostash" flag for git pull --rebase, which will
> override "rebase.autostash" configuration(if set false) and will pass --autostash to
> git rebase. I would like to know your opinion on this option.

That was the point of the microproject ;-). --[no-]autostash means
both --autostash and --no-autostash.

Thanks,
Paul

Re: [GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[Mehul Jain]

On Fri, Feb 26, 2016 at 5:21 PM, Paul Tan <pyokagan@gmail.com> wrote:
> That was the point of the microproject ;-). --[no-]autostash means
> both --autostash and --no-autostash.

Oops, my bad. I will add the necessary changes :-).

Thanks,
Mehul

Re: [PATCH] Add --no-autostash flag to git pull --rebase

[Paul Tan]

On Fri, Feb 26, 2016 at 7:23 PM, Mehul Jain <mehul.jain2029@gmail.com> wrote:
> Subject: [PATCH] Add --no-autostash flag to git pull --rebase

We usually don't capitalize the first word of the commit title. We
also usually prefix the commit title with the relevant subsystem, file
or command. So something like:

pull --rebase: add --[no-]autostash flag

Some grammatical/spelling nits below:

> git pull --rebase now understand --no-autostash flag.

s/understand/understands the/

> If directory is found to be dirty then command will die.

If the worktree is found to be dirty then the command will die.

(Perhaps state more clearly that the dirty worktree check is only
performed on --no-autostash or rebase.autostash=false.)

> This flag override "rebase.autostash" configuration(if set).

s/override/overrides the/

> If this flag is not passed in command line then default behaviour is choosen,

s/choosen/chosen/

> given by "rebase.autostash"(if "rebase.autostash"
> is not set then git pull --rebase will die if directory is dirty).

If "rebase.autostash" is not set or is false. Or you could shorten it
by saying that "(default is false)".

> Signed-off-by: Mehul Jain <mehul.jain2029@gmail.com>
> ---
>  builtin/pull.c          | 12 ++++++++----
>  t/t5520-pull.sh         |  8 ++++++++
>  t/t5521-pull-options.sh | 24 ++++++++++++++++++++++++
>  3 files changed, 40 insertions(+), 4 deletions(-)

I think git-pull's documentation should be updated as well to talk
about this new command-line switch.

> diff --git a/builtin/pull.c b/builtin/pull.c
> index 10eff03..9d1a3d0 100644
> --- a/builtin/pull.c
> +++ b/builtin/pull.c
> @@ -85,6 +85,7 @@ static char *opt_squash;
>  static char *opt_commit;
>  static char *opt_edit;
>  static char *opt_ff;
> +static int opt_autostash = -1;
>  static char *opt_verify_signatures;
>  static struct argv_array opt_strategies = ARGV_ARRAY_INIT;
>  static struct argv_array opt_strategy_opts = ARGV_ARRAY_INIT;
> @@ -146,6 +147,8 @@ static struct option pull_options[] = {
>         OPT_PASSTHRU(0, "ff-only", &opt_ff, NULL,
>                 N_("abort if fast-forward is not possible"),
>                 PARSE_OPT_NOARG | PARSE_OPT_NONEG),
> +       OPT_COLOR_FLAG(0,"autostash",&opt_autostash,
> +               N_("abort if tree is dirty")),

Why OPT_COLOR_FLAG()? And --autostash is not just about aborting if
the working tree is dirty. Why not just copy the help message from
git-rebase? Something like:

"automatically stash/stash pop before and after rebase"

>         OPT_PASSTHRU(0, "verify-signatures", &opt_verify_signatures, NULL,
>                 N_("verify that the named commit has a valid GPG signature"),
>                 PARSE_OPT_NOARG),
> @@ -835,13 +838,14 @@ int cmd_pull(int argc, const char **argv, const char *prefix)
>                 hashclr(orig_head);
>
>         if (opt_rebase) {
> -               int autostash = 0;
> -
>                 if (is_null_sha1(orig_head) && !is_cache_unborn())
>                         die(_("Updating an unborn branch with changes added to the index."));
>
> -               git_config_get_bool("rebase.autostash", &autostash);
> -               if (!autostash)
> +               if(opt_autostash < 0)
> +                       if(git_config_get_bool("rebase.autostash",&opt_autostash))
> +                               opt_autostash = 0;

I wonder if this code could be shortened if we simply just called
git_config_get_bool() just before parse_options(). That way, we don't
need to check for the "-1" special value.

> +
> +               if (!opt_autostash)
>                         die_on_unclean_work_tree(prefix);

OK.

>
>                 if (get_rebase_fork_point(rebase_fork_point, repo, *refspecs))
> diff --git a/t/t5520-pull.sh b/t/t5520-pull.sh
> index c952d5e..512d3bf 100755
> --- a/t/t5520-pull.sh
> +++ b/t/t5520-pull.sh
> @@ -245,6 +245,14 @@ test_expect_success '--rebase fails with multiple branches' '
>         test modified = "$(git show HEAD:file)"
>  '
>
> +test_expect_success '--rebase --no-autostash fails with dirty working directory' '

Maybe add ..."and rebase.autostash set" to the test name? Describes
the test better, and is consistent with the name of the test below.

> +       test_config rebase.autostash true &&
> +       git reset --hard before-rebase &&
> +       echo dirty >new_file &&
> +       git add new_file &&
> +       test_must_fail git pull --rebase --no-autostash . copy
> +'
> +
>  test_expect_success 'pull --rebase succeeds with dirty working directory and rebase.autostash set' '
>         test_config rebase.autostash true &&
>         git reset --hard before-rebase &&
> diff --git a/t/t5521-pull-options.sh b/t/t5521-pull-options.sh
> index 18372ca..22ff5d7 100755
> --- a/t/t5521-pull-options.sh
> +++ b/t/t5521-pull-options.sh
> @@ -62,6 +62,30 @@ test_expect_success 'git pull -v --rebase' '
>         test_must_be_empty out)
>  '
>
> +test_expect_success 'git pull --rebase --no-autostash' '
> +       mkdir clonedrbnas &&

Took me some time to realize this directory name is actually "cloned"
+ "rb" (from --rebase) and "nas" (--no-autostash) ;-)

> +       (cd clonedrbnas  && git init &&
> +       git pull --rebase --no-autostash "../parent" >out 2>err &&
> +       test -s err &&
> +       test_must_be_empty out)
> +'
> +
> +test_expect_success 'git pull -q --rebase --no-autostash' '
> +       mkdir clonedqrbnas &&
> +       (cd clonedqrbnas  && git init &&
> +       git pull -q --rebase --no-autostash "../parent" >out 2>err &&
> +       test_must_be_empty err &&
> +       test_must_be_empty out)
> +'
> +
> +test_expect_success 'git pull -v --rebase --no-autostash' '
> +       mkdir clonedvrbnas &&
> +       (cd clonedvrbnas && git init &&
> +       git pull -v --rebase --no-autostash "../parent" >out 2>err &&
> +       test -s err &&
> +       test_must_be_empty out)
> +'

While more tests are always good, I don't think we need to test for
"-q" and "-v" with --no-autostash, because it's already covered by the
test for "git pull -q --rebase". Perhaps with --autostash, but even
then I don't think we need a test for "-v".

> +
>  test_expect_success 'git pull -v -q' '
>         mkdir clonedvq &&
>         (cd clonedvq && git init &&
> --
> 2.7.1.340.g69eb491.dirty

Thanks,
Paul

Re: [GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[Matthieu Moy]

Hi,

Some minor nits in addition to Paul's comments:

> Subject: Re: [GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

The ":-" is typically Indian. Just use ":" here (without a space
before).

Mehul Jain <mehul.jain2029@gmail.com> writes:

> With this patch, git pull --rebase will understand --no-autostash command line flag.
> This flag will override "rebase.autostash" configuration(if set)

Here and elsewhere: space before "(".

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

Re: [PATCH] Add --no-autostash flag to git pull --rebase

[Mehul Jain]

Hi,

Thank you for the suggestions.
On Fri, Feb 26, 2016 at 6:17 PM, Paul Tan <pyokagan@gmail.com> wrote:
> Some grammatical/spelling nits below:

Many apologies for my English.

> I think git-pull's documentation should be updated as well to talk
> about this new command-line switch.

OK.

>> diff --git a/builtin/pull.c b/builtin/pull.c
>> index 10eff03..9d1a3d0 100644
>> --- a/builtin/pull.c
>> +++ b/builtin/pull.c
>> @@ -85,6 +85,7 @@ static char *opt_squash;
>>  static char *opt_commit;
>>  static char *opt_edit;
>>  static char *opt_ff;
>> +static int opt_autostash = -1;
>>  static char *opt_verify_signatures;
>>  static struct argv_array opt_strategies = ARGV_ARRAY_INIT;
>>  static struct argv_array opt_strategy_opts = ARGV_ARRAY_INIT;
>> @@ -146,6 +147,8 @@ static struct option pull_options[] = {
>>         OPT_PASSTHRU(0, "ff-only", &opt_ff, NULL,
>>                 N_("abort if fast-forward is not possible"),
>>                 PARSE_OPT_NOARG | PARSE_OPT_NONEG),
>> +       OPT_COLOR_FLAG(0,"autostash",&opt_autostash,
>> +               N_("abort if tree is dirty")),
>
> Why OPT_COLOR_FLAG()? And --autostash is not just about aborting if
> the working tree is dirty. Why not just copy the help message from
> git-rebase? Something like:
> "automatically stash/stash pop before and after rebase"

Using OPT_COLOR_FLAG() is wrong, I agree. OPT_BOOL will be a better option.
N_("automatically stash/stash pop before and after rebase") is better.

>>         OPT_PASSTHRU(0, "verify-signatures", &opt_verify_signatures, NULL,
>>                 N_("verify that the named commit has a valid GPG signature"),
>>                 PARSE_OPT_NOARG),
>> @@ -835,13 +838,14 @@ int cmd_pull(int argc, const char **argv, const char *prefix)
>>                 hashclr(orig_head);
>>
>>         if (opt_rebase) {
>> -               int autostash = 0;
>> -
>>                 if (is_null_sha1(orig_head) && !is_cache_unborn())
>>                         die(_("Updating an unborn branch with changes added to the index."));
>>
>> -               git_config_get_bool("rebase.autostash", &autostash);
>> -               if (!autostash)
>> +               if(opt_autostash < 0)
>> +                       if(git_config_get_bool("rebase.autostash",&opt_autostash))
>> +                               opt_autostash = 0;
>
> I wonder if this code could be shortened if we simply just called
> git_config_get_bool() just before parse_options(). That way, we don't
> need to check for the "-1" special value.

Definitely. This way opt_autostash can be initialized with 0, thus default
will be false.

>>
>> +               if (!opt_autostash)
>>                         die_on_unclean_work_tree(prefix);
>
> OK.
>
>>
>>                 if (get_rebase_fork_point(rebase_fork_point, repo, *refspecs))
>> diff --git a/t/t5520-pull.sh b/t/t5520-pull.sh
>> index c952d5e..512d3bf 100755
>> --- a/t/t5520-pull.sh
>> +++ b/t/t5520-pull.sh
>> @@ -245,6 +245,14 @@ test_expect_success '--rebase fails with multiple branches' '
>>         test modified = "$(git show HEAD:file)"
>>  '
>>
>> +test_expect_success '--rebase --no-autostash fails with dirty working directory' '
>
> Maybe add ..."and rebase.autostash set" to the test name? Describes
> the test better, and is consistent with the name of the test below.

Can be done. But which one of these will be more appropriate:
 "rebase.autostash set" or "rebase.autostash set true".
I prefer latter, as it will maintain consistence with the test name of
"--rebase --autostash", which will be
'--rebase --autostash succeeds with dirty working directory and
rebase.autostash set false.'


>> +test_expect_success 'git pull -q --rebase --no-autostash' '
>> +       mkdir clonedqrbnas &&
>> +       (cd clonedqrbnas  && git init &&
>> +       git pull -q --rebase --no-autostash "../parent" >out 2>err &&
>> +       test_must_be_empty err &&
>> +       test_must_be_empty out)
>> +'
>> +
>> +test_expect_success 'git pull -v --rebase --no-autostash' '
>> +       mkdir clonedvrbnas &&
>> +       (cd clonedvrbnas && git init &&
>> +       git pull -v --rebase --no-autostash "../parent" >out 2>err &&
>> +       test -s err &&
>> +       test_must_be_empty out)
>> +'
>
> While more tests are always good, I don't think we need to test for
> "-q" and "-v" with --no-autostash, because it's already covered by the
> test for "git pull -q --rebase". Perhaps with --autostash, but even
> then I don't think we need a test for "-v".

OK then. I will only add tests for "git pull --rebase --no-autostash",
"git pull --rebase --autostash" and
"git pull -q --rebase --autostash" in t5521-pull-options.sh

Thanks,
Mehul Jain

Re: [GSoC] Microproject :- Teaching git pull --rebase the --no-autostash flag

[Philip Oakley]

From: "Matthieu Moy" <Matthieu.Moy@grenoble-inp.fr>
> Hi,
>
> Some minor nits in addition to Paul's comments:
>
>> Subject: Re: [GSoC] Microproject :- Teaching git pull --rebase 
>> the --no-autostash flag
>
> The ":-" is typically Indian. Just use ":" here (without a space
> before).

I think it was we Brit's who are to blame. While less frequent these days it 
was common here in Briton. I certainly use it sometimes ;-)

http://english.stackexchange.com/questions/31060/is-it-proper-to-use-a-colon-followed-immediately-by-a-hyphen

https://www.quora.com/What-is-this-punctuation-called (originalism would 
also suggest USA..)


>
> Mehul Jain <mehul.jain2029@gmail.com> writes:
>
>> With this patch, git pull --rebase will understand --no-autostash command 
>> line flag.
>> This flag will override "rebase.autostash" configuration(if set)
>
> Here and elsewhere: space before "(".
>
> -- 
> Matthieu Moy
> http://www-verimag.imag.fr/~moy/
> --

Philip