initial branch: give hints after switching the default name

It is likely that those who came to Git after 3.0 switched the
default initial branch name to 'main' would still try to follow
tutorials that were written before 3.0 happened and with the
assumption that the tool would call the initial branch 'master'.

To help these new users after 3.0 boundary, let's retain one part of
the hint we will be giving before the default changes, namely, how
to rename the branch an unconfigured Git has created just once.

We do this without telling them how to permanently configure the
default name of the initial branch, and that design choice is very
much deliberate.  The whole point of switching the default name was
because we did not want to force individual users to configure their
default branch name but while the hard wired default was 'master',
they _had_ to configure it away from 'master' in order to conform to
the recent norm, and a hint that tells them how to do so is useful.

But once the default is renamed to 'main', that no longer is true.
A narrower audience who are new users that follow an instruction
that assumes the initial branch name is 'master' would only need to
learn "here is how to change the branch name to match the tutorial
you are following in the repository you created for practice", and
"here is how you keep creating repositories with the first branch
with a name everybody hates" is unnecessary.

It also needs to be noted that the advise token to squelch the
message is the same advice.defaultBranchName as before, which is
also very much deliberate.  The users who do have that configured
are those who _have_ been using Git since before 3.0, and they are
not the target audience for the new advice message.  Reusing the
same advise token ensures that they do not have to turn the message
off.

Helped-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/advice.c b/advice.c
index 48c49ee4145267a33d44f9d3397933d18d7dedbf..e5f0ff844917ec5927d15c10a07cad873598d545 100644 (file)
--- a/advice.c
+++ b/advice.c
@@ -51,9 +51,7 @@ static struct {
        [ADVICE_AM_WORK_DIR]                            = { "amWorkDir" },
        [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME]  = { "checkoutAmbiguousRemoteBranchName" },
        [ADVICE_COMMIT_BEFORE_MERGE]                    = { "commitBeforeMerge" },
-#ifndef WITH_BREAKING_CHANGES
        [ADVICE_DEFAULT_BRANCH_NAME]                    = { "defaultBranchName" },
-#endif /* WITH_BREAKING_CHANGES */
        [ADVICE_DETACHED_HEAD]                          = { "detachedHead" },
        [ADVICE_DIVERGING]                              = { "diverging" },
        [ADVICE_FETCH_SET_HEAD_WARN]                    = { "fetchRemoteHEADWarn" },

diff --git a/advice.h b/advice.h
index fc1dc8720493d1cc5d50eb22059c4b4b2f3d0db9..8def28068861df05851c70025f819e3a390dd71c 100644 (file)
--- a/advice.h
+++ b/advice.h
@@ -18,9 +18,7 @@ enum advice_type {
        ADVICE_AM_WORK_DIR,
        ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
        ADVICE_COMMIT_BEFORE_MERGE,
-#ifndef WITH_BREAKING_CHANGES
-       ADVICE_DEFAULT_BRANCH_NAME,
-#endif /* WITH_BREAKING_CHANGES */
+       ADVICE_DEFAULT_BRANCH_NAME, /* To be retired sometime after Git 3.0 */
        ADVICE_DETACHED_HEAD,
        ADVICE_DIVERGING,
        ADVICE_FETCH_SET_HEAD_WARN,

diff --git a/refs.c b/refs.c
index 149a8d1cec1944d5b16856eba1bbdb245d6abb6a..f15366bfcec9aba13fe89dbca9b43caf1bd9748a 100644 (file)
--- a/refs.c
+++ b/refs.c
@@ -641,9 +641,17 @@ static const char default_branch_name_advice[] = N_(
 "\n"
 "\tgit branch -m <name>\n"
 );
+#else
+static const char default_branch_name_advice[] = N_(
+"Using '%s' as the name for the initial branch since Git 3.0.\n"
+"If you expected Git to create 'master', the just-created\n"
+"branch can be renamed via this command:\n"
+"\n"
+"\tgit branch -m master\n"
+);
 #endif /* WITH_BREAKING_CHANGES */
 
-char *repo_default_branch_name(struct repository *r, MAYBE_UNUSED int quiet)
+char *repo_default_branch_name(struct repository *r, int quiet)
 {
        const char *config_key = "init.defaultbranch";
        const char *config_display_key = "init.defaultBranch";
@@ -660,10 +668,10 @@ char *repo_default_branch_name(struct repository *r, MAYBE_UNUSED int quiet)
                ret = xstrdup("main");
 #else
                ret = xstrdup("master");
+#endif /* WITH_BREAKING_CHANGES */
                if (!quiet)
                        advise_if_enabled(ADVICE_DEFAULT_BRANCH_NAME,
                                          _(default_branch_name_advice), ret);
-#endif /* WITH_BREAKING_CHANGES */
        }
 
        full_ref = xstrfmt("refs/heads/%s", ret);

diff --git a/t/t0001-init.sh b/t/t0001-init.sh
index df0040b9ace1d3d47252093c31e0f188f623796f..618da080dc9ea9564fade0e6f2570df3f90b933c 100755 (executable)
--- a/t/t0001-init.sh
+++ b/t/t0001-init.sh
@@ -868,7 +868,7 @@ test_expect_success 'overridden default initial branch name (config)' '
        grep nmb actual
 '
 
-test_expect_success !WITH_BREAKING_CHANGES 'advice on unconfigured init.defaultBranch' '
+test_expect_success 'advice on unconfigured init.defaultBranch' '
        GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME= git -c color.advice=always \
                init unconfigured-default-branch-name 2>err &&
        test_decode_color <err >decoded &&

diff --git a/t/test-lib.sh b/t/test-lib.sh
index b191954c3c445df81e7183328501efa5e6ec7bf8..562f950fb0aec28c53485f22c88d8a069e6f81b9 100644 (file)
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -127,13 +127,17 @@ then
        export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
 fi
 
+# Explicitly set the default branch name for testing, to squelch hints
+# from "git init" during the transition period.  Should be removed
+# after we decide to remove ADVICE_DEFAULT_BRANCH_NAME
 if test -z "$WITH_BREAKING_CHANGES"
 then
-       # Explicitly set the default branch name for testing, to avoid the
-       # transitory "git init" warning under --verbose.
        : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=master}
-       export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
+else
+       : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=main}
 fi
+export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
+
 
 ################################################################
 # It appears that people try to run tests without building...