path: root/Documentation/git-init-db.txt
diff options
authorJunio C Hamano <>2007-01-11 20:58:10 (GMT)
committerJunio C Hamano <>2007-01-11 20:58:10 (GMT)
commitd145144c3ba050a1a8c8296f337b77a18500af00 (patch)
treea9bad72f92792c2a2784c0db9d56a128ec51daa9 /Documentation/git-init-db.txt
parent2cdf9509df66358f83a577caf83dc06e3161ec3c (diff)
Document git-init
These days, the command does a lot more than just initialise the object database (such as setting default config-variables, installing template hooks...), and "git init" is actually a more sensible name nowadays. Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-init-db.txt')
1 files changed, 2 insertions, 89 deletions
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index bc3ba14..5412135 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -11,96 +11,9 @@ SYNOPSIS
'git-init-db' [--template=<template_directory>] [--shared[=<permissions>]]
-Provide the directory from which templates will be used. The default template
-directory is `/usr/share/git-core/templates`.
-When specified, `<template_directory>` is used as the source of the template
-files rather than the default. The template files include some directory
-structure, some suggested "exclude patterns", and copies of non-executing
-"hook" files. The suggested patterns and hook files are all modifiable and
-Specify that the git repository is to be shared amongst several users. This
-allows users belonging to the same group to push into that
-repository. When specified, the config variable "core.sharedRepository" is
-set so that files and directories under `$GIT_DIR` are created with the
-requested permissions. When not specified, git will use permissions reported
-by umask(2).
-The option can have the following values, defaulting to 'group' if no value
-is given:
- - 'umask' (or 'false'): Use permissions reported by umask(2). The default,
- when `--shared` is not specified.
- - 'group' (or 'true'): Make the repository group-writable, (and g+sx, since
- the git group may be not the primary group of all users).
- - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository
- readable by all users.
-By default, the configuration flag receive.denyNonFastforward is enabled
-in shared repositories, so that you cannot force a non fast-forwarding push
-into it.
-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.
-If the `$GIT_DIR` environment variable is set then it specifies a path
-to use instead of `./.git` for the base of the repository.
-If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY`
-environment variable then the sha1 directories are created underneath -
-otherwise the default `$GIT_DIR/objects` directory is used.
-Running `git-init-db` in an existing repository is safe. It will not overwrite
-things that are already there. The primary reason for rerunning `git-init-db`
-is to pick up newly added templates.
-Note that `git-init` is the same as `git-init-db`.
-Start a new git repository for an existing code base::
-$ cd /path/to/my/codebase
-$ git-init-db <1>
-$ git-add . <2>
-<1> prepare /path/to/my/codebase/.git directory
-<2> add all existing file to the index
-Written by Linus Torvalds <>
-Documentation by David Greaves, Junio C Hamano and the git-list <>.
-Part of the gitlink:git[7] suite
+This is a synonym for gitlink:git-init[1]. Please refer to the
+documentation of that command.