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>
Jon Loeliger committed
Mar 17, 2006 at 18:24 UTC
81ea3ce2ace4d8b76dbfe2aa6b4199472115a115
1 file changed
+13
-5
Documentation/git-init-db.txt
+13
-5
@@ -14,7 +14,8 @@ SYNOPSIS
14
OPTIONS
15
-------
16
--template=<template_directory>::
17
- Provide the directory in from which templates will be used.
17
+ Provide the directory from which templates will be used.
18
+ The default template directory is `/usr/share/git-core/templates`.
19
20
--shared::
21
Specify that the git repository is to be shared amongst several users.
@@ -22,9 +23,17 @@ OPTIONS
23
24
DESCRIPTION
25
-----------
25
-This simply creates an empty git repository - basically a `.git` directory
26
-and `.git/object/??/`, `.git/refs/heads` and `.git/refs/tags` directories,
27
-and links `.git/HEAD` symbolically to `.git/refs/heads/master`.
26
+This command creates an empty git repository - basically a `.git` directory
27
+with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
28
+templated files.
29
+An initial `HEAD` file that references the HEAD of the master branch
30
+is also created.
31
+
32
+If `--template=<template_directory>` is specified, `<template_directory>`
33
+is used as the source of the template files rather than the default.
34
+The template files include some directory structure, some suggested
35
+"exclude patterns", and copies of non-executing "hook" files. The
36
+suggested patterns and hook files are all modifiable and extensible.
37
38
If the `$GIT_DIR` environment variable is set then it specifies a path
39
to use instead of `./.git` for the base of the repository.
@@ -38,7 +47,6 @@ repository. When specifying `--shared` the config variable "core.sharedRepositor
47
is set to 'true' so that directories under `$GIT_DIR` are made group writable
48
(and g+sx, since the git group may be not the primary group of all users).
49
41
-
50
Running `git-init-db` in an existing repository is safe. It will not overwrite
51
things that are already there. The primary reason for rerunning `git-init-db`
52
is to pick up newly added templates.