development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 11:39:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

init: document init.defaultBranch better

Browse source 
Our documentation does not mention any future plan to change 'master' to
other value. It is a good idea to document this, though.

Initial-patch-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Johannes Schindelin 2020-12-11 11:36:54 +00:00 committed by Junio C Hamano
parent b291b0a628
commit 1296cbe4b4
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Documentation/git-init.txt
View file

@ -20,8 +20,9 @@ DESCRIPTION
This command creates an empty Git repository - basically a `.git` This command creates an empty Git repository - basically a `.git`
directory with subdirectories for `objects`, `refs/heads`, directory with subdirectories for `objects`, `refs/heads`,
`refs/tags`, and template files. An initial `HEAD` file that `refs/tags`, and template files. An initial branch without any
references the HEAD of the master branch is also created. commits will be created (see the `--initial-branch` option below
for its name).
If the `$GIT_DIR` environment variable is set then it specifies a path If the `$GIT_DIR` environment variable is set then it specifies a path
to use instead of `./.git` for the base of the repository. 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>:: -b <branch-name>::
--initial-branch=<branch-name>:: --initial-branch=<branch-name>::
Use the specified name for the initial branch in the newly created repository. Use the specified name for the initial branch in the newly created
If not specified, fall back to the default name: `master`. repository. If not specified, fall back to the default name (currently
`master`, but this is subject to change in the future; the name can be
customized via the `init.defaultBranch` configuration variable).
--shared[=(false|true|umask|group|all|world|everybody|0xxx)]:: --shared[=(false|true|umask|group|all|world|everybody|0xxx)]::