summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJon Loeliger <jdl@jdl.com>2006-03-18 00:24:49 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-03-18 04:42:31 (GMT)
commit81ea3ce2ace4d8b76dbfe2aa6b4199472115a115 (patch)
treefb8a4e315eeac121eeeb41603293c5ecf63c9a6b /Documentation
parentdd1811199ed01280f882f9907e743153b4a2c937 (diff)
downloadgit-81ea3ce2ace4d8b76dbfe2aa6b4199472115a115.zip
git-81ea3ce2ace4d8b76dbfe2aa6b4199472115a115.tar.gz
git-81ea3ce2ace4d8b76dbfe2aa6b4199472115a115.tar.bz2
Document the default source of template files.
Also explain a bit more about how the template option works. Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-init-db.txt18
1 files changed, 13 insertions, 5 deletions
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index ea4d849..aeb1115 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -14,7 +14,8 @@ SYNOPSIS
OPTIONS
-------
--template=<template_directory>::
- Provide the directory in from which templates will be used.
+ Provide the directory from which templates will be used.
+ The default template directory is `/usr/share/git-core/templates`.
--shared::
Specify that the git repository is to be shared amongst several users.
@@ -22,9 +23,17 @@ OPTIONS
DESCRIPTION
-----------
-This simply creates an empty git repository - basically a `.git` directory
-and `.git/object/??/`, `.git/refs/heads` and `.git/refs/tags` directories,
-and links `.git/HEAD` symbolically to `.git/refs/heads/master`.
+This command creates an empty git repository - basically a `.git` directory
+with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
+templated files.
+An initial `HEAD` file that references the HEAD of the master branch
+is also created.
+
+If `--template=<template_directory>` is 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 extensible.
If the `$GIT_DIR` environment variable is set then it specifies a path
to use instead of `./.git` for the base of the repository.
@@ -38,7 +47,6 @@ repository. When specifying `--shared` the config variable "core.sharedRepositor
is set to 'true' so that directories under `$GIT_DIR` are made group writable
(and g+sx, since the git group may be not the primary group of all users).
-
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.