pull: warn if the user didn't say whether to rebase or to merge
Often novice Git users forget to say "pull --rebase" and end up with an unnecessary merge from upstream. What they usually want is either "pull --rebase" in the simpler cases, or "pull --ff-only" to update the copy of main integration branches, and rebase their work separately. The pull.rebase configuration variable exists to help them in the simpler cases, but there is no mechanism to make these users aware of it. Issue a warning message when no --[no-]rebase option from the command line and no pull.rebase configuration variable is given. This will inconvenience those who never want to "pull --rebase", who haven't had to do anything special, but the cost of the inconvenience is paid only once per user, which should be a reasonable cost to help a number of new users. Signed-off-by: Alex Henrie <alexhenrie24@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Alex Henrie committed
Mar 9, 2020 at 21:54 UTC
d18c950a69f3a24e1e3add3d9fc427641f53e12b
3 files changed
+65
-11
builtin/pull.c
+16
@@ -327,6 +327,22 @@ static enum rebase_type config_get_rebase(void)
327
if (!git_config_get_value("pull.rebase", &value))
328
return parse_config_rebase("pull.rebase", value, 1);
329
330
+ if (opt_verbosity >= 0 &&
331
+ (!opt_ff || strcmp(opt_ff, "--ff-only"))) {
332
+ warning(_("Pulling without specifying how to reconcile divergent branches is\n"
333
+ "discouraged. You can squelch this message by running one of the following\n"
334
+ "commands sometime before your next pull:\n"
335
+ "\n"
336
+ " git config pull.rebase false # merge (the default strategy)\n"
337
+ " git config pull.rebase true # rebase\n"
338
+ " git config pull.ff only # fast-forward only\n"
339
+ "\n"
340
+ "You can replace \"git config\" with \"git config --global\" to set a default\n"
341
+ "preference for all repositories. You can also pass --rebase, --no-rebase,\n"
342
+ "or --ff-only on the command line to override the configured default per\n"
343
+ "invocation.\n"));
344
+ }
345
+
346
return REBASE_FALSE;
347
}
348
t/t5521-pull-options.sh
+11
-11
@@ -11,10 +11,10 @@ test_expect_success 'setup' '
11
git commit -m one)
12
'
13
14
-test_expect_success 'git pull -q' '
14
+test_expect_success 'git pull -q --no-rebase' '
15
mkdir clonedq &&
16
(cd clonedq && git init &&
17
- git pull -q "../parent" >out 2>err &&
17
+ git pull -q --no-rebase "../parent" >out 2>err &&
18
test_must_be_empty err &&
19
test_must_be_empty out)
20
'
@@ -30,10 +30,10 @@ test_expect_success 'git pull -q --rebase' '
30
test_must_be_empty out)
31
'
32
33
-test_expect_success 'git pull' '
33
+test_expect_success 'git pull --no-rebase' '
34
mkdir cloned &&
35
(cd cloned && git init &&
36
- git pull "../parent" >out 2>err &&
36
+ git pull --no-rebase "../parent" >out 2>err &&
37
test -s err &&
38
test_must_be_empty out)
39
'
@@ -46,10 +46,10 @@ test_expect_success 'git pull --rebase' '
46
test_must_be_empty out)
47
'
48
49
-test_expect_success 'git pull -v' '
49
+test_expect_success 'git pull -v --no-rebase' '
50
mkdir clonedv &&
51
(cd clonedv && git init &&
52
- git pull -v "../parent" >out 2>err &&
52
+ git pull -v --no-rebase "../parent" >out 2>err &&
53
test -s err &&
54
test_must_be_empty out)
55
'
@@ -62,25 +62,25 @@ test_expect_success 'git pull -v --rebase' '
62
test_must_be_empty out)
63
'
64
65
-test_expect_success 'git pull -v -q' '
65
+test_expect_success 'git pull -v -q --no-rebase' '
66
mkdir clonedvq &&
67
(cd clonedvq && git init &&
68
- git pull -v -q "../parent" >out 2>err &&
68
+ git pull -v -q --no-rebase "../parent" >out 2>err &&
69
test_must_be_empty out &&
70
test_must_be_empty err)
71
'
72
73
-test_expect_success 'git pull -q -v' '
73
+test_expect_success 'git pull -q -v --no-rebase' '
74
mkdir clonedqv &&
75
(cd clonedqv && git init &&
76
- git pull -q -v "../parent" >out 2>err &&
76
+ git pull -q -v --no-rebase "../parent" >out 2>err &&
77
test_must_be_empty out &&
78
test -s err)
79
'
80
test_expect_success 'git pull --cleanup errors early on invalid argument' '
81
mkdir clonedcleanup &&
82
(cd clonedcleanup && git init &&
83
- test_must_fail git pull --cleanup invalid "../parent" >out 2>err &&
83
+ test_must_fail git pull --no-rebase --cleanup invalid "../parent" >out 2>err &&
84
test_must_be_empty out &&
85
test -s err)
86
'
t/t7601-merge-pull-config.sh
+38
@@ -27,6 +27,44 @@ test_expect_success 'setup' '
27
git tag c3
28
'
29
30
+test_expect_success 'pull.rebase not set' '
31
+ git reset --hard c0 &&
32
+ git pull . c1 2>err &&
33
+ test_i18ngrep "Pulling without specifying how to reconcile" err
34
+'
35
+
36
+test_expect_success 'pull.rebase not set and pull.ff=false' '
37
+ git reset --hard c0 &&
38
+ test_config pull.ff false &&
39
+ git pull . c1 2>err &&
40
+ test_i18ngrep "Pulling without specifying how to reconcile" err
41
+'
42
+
43
+test_expect_success 'pull.rebase not set and pull.ff=only' '
44
+ git reset --hard c0 &&
45
+ test_config pull.ff only &&
46
+ git pull . c1 2>err &&
47
+ test_i18ngrep ! "Pulling without specifying how to reconcile" err
48
+'
49
+
50
+test_expect_success 'pull.rebase not set and --rebase given' '
51
+ git reset --hard c0 &&
52
+ git pull --rebase . c1 2>err &&
53
+ test_i18ngrep ! "Pulling without specifying how to reconcile" err
54
+'
55
+
56
+test_expect_success 'pull.rebase not set and --no-rebase given' '
57
+ git reset --hard c0 &&
58
+ git pull --no-rebase . c1 2>err &&
59
+ test_i18ngrep ! "Pulling without specifying how to reconcile" err
60
+'
61
+
62
+test_expect_success 'pull.rebase not set and --ff-only given' '
63
+ git reset --hard c0 &&
64
+ git pull --ff-only . c1 2>err &&
65
+ test_i18ngrep ! "Pulling without specifying how to reconcile" err
66
+'
67
+
68
test_expect_success 'merge c1 with c2' '
69
git reset --hard c1 &&
70
test -f c0.c &&