diff options
| author | Johannes Schindelin <johannes.schindelin@gmx.de> | 2020-12-11 11:36:54 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-12-13 15:53:50 -0800 |
| commit | 1296cbe4b4675f429eb20b85bb86ec61546103fb (patch) | |
| tree | 6ed602daf1c1885d46ec61b079aa6fb9ea3c729c /Documentation/git-init.txt | |
| parent | b291b0a628020eedb10b6236d87fe25d295cea81 (diff) | |
| download | git-1296cbe4b4675f429eb20b85bb86ec61546103fb.tar.gz | |
init: document `init.defaultBranch` better
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>
Diffstat (limited to 'Documentation/git-init.txt')
| -rw-r--r-- | Documentation/git-init.txt | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 59ecda6c17..b611d80697 100644 --- a/Documentation/git-init.txt +++ b/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 initial branch without any +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 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 (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)]:: |