git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Peter Hadlaw <hadlawp@gmail.com>,
	Johannes Schindelin <johannes.schindelin@gmx.de>
Cc: git@vger.kernel.org
Subject: Re* Keeping the original init.defaultBranch config value
Date: Wed, 18 Nov 2020 09:35:15 -0800	[thread overview]
Message-ID: <xmqqd00a36wc.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <CABrPy+GrSB87mFm5tXsXkC+OKg6NBxUJA5b0NYsa18a8EbcrNw@mail.gmail.com> (Peter Hadlaw's message of "Wed, 18 Nov 2020 10:46:30 -0600")

Peter Hadlaw <hadlawp@gmail.com> writes:

> Hello,
>
> Just wanted to confirm that in order to keep new repositories
> initializing with `master` as the default branch the command would be:
>
> ```
> git config --global init.defaultBranch master
> ```

Yes.

If you have to ask the above question, that would mean the
documentation we have right now probably is not clear enough.  

It is understandable, given that our documentation does not mention
any future plan to change 'master' to other value, but it may still
be a good idea.

The following patch is on 'seen' with Dscho's "prepare for main but
do not flip the final switch yet" series.  I am not committed to the
phrasing, but just showing it as a discussion starter.

Thanks.

--- >8 ------ >8 ------ >8 --- cut here --- >8 ------ >8 ---
Subject: "init" doc: mention the configurability more clearly

Update the description for the '--initial-branch' option to mention
that the historical default has been `master` and it can be
configured to use any name.  When actual transition happens to
another fixed name, say 'main', the description would further be
updated to mention like:

	... fall back to the default name 'main', but it can be
	customized with the `init.defaultBranch` configuration
	variable.  Note that the default name historically was
	'master'.

in order to help people who wonder why more mature projects or
documentation tend not to say 'main'.

While we are at it, stop referring to "HEAD file", which was a
remnant from 2005 that talks too much about implementation detail.
The most important fact is that the current branch is set to an
unborn branch and not detached HEAD.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-init.txt | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git i/Documentation/git-init.txt w/Documentation/git-init.txt
index 59ecda6c17..62c7552a12 100644
--- i/Documentation/git-init.txt
+++ w/Documentation/git-init.txt
@@ -20,8 +20,9 @@ DESCRIPTION
 
 This command creates an empty Git repository - basically a `.git`
 directory with subdirectories for `objects`, `refs/heads`,
-`refs/tags`, and template files.  An initial `HEAD` file that
-references the HEAD of the master branch is also created.
+`refs/tags`, and template files.  An unborn branch (see the
+`--initial-branch` option below for its name) is made to the current
+branch.
 
 If the `$GIT_DIR` environment variable is set then it specifies a path
 to use instead of `./.git` for the base of the repository.
@@ -73,8 +74,10 @@ If this is reinitialization, the repository will be moved to the specified path.
 -b <branch-name>::
 --initial-branch=<branch-name>::
 
-Use the specified name for the initial branch in the newly created repository.
-If not specified, fall back to the default name: `master`.
+Use the specified name for the initial branch in the newly created
+repository.  If not specified, fall back to the default name
+'master', but it can be customized with the `init.defaultBranch`
+configuration variable.
 
 --shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
 
o

  reply	other threads:[~2020-11-18 17:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-18 16:46 Peter Hadlaw
2020-11-18 17:35 ` Junio C Hamano [this message]
2020-11-22 19:00   ` Re* " Johannes Schindelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqd00a36wc.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=hadlawp@gmail.com \
    --cc=johannes.schindelin@gmx.de \
    --subject='Re: Re* Keeping the original init.defaultBranch config value' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).