summaryrefslogtreecommitdiff
path: root/Documentation/git-init.txt
diff options
context:
space:
mode:
authorSteven Drake <sdrake@xnet.co.nz>2010-02-17 12:44:46 +1300
committerJunio C Hamano <gitster@pobox.com>2010-02-17 12:17:53 -0800
commitd8a8488d569420c4e0a96a8df36b246d888e68d4 (patch)
treed9f19002be9ae33419ef58be6b6843640fbf7472 /Documentation/git-init.txt
parent90b45187ba51a15c8a80680597240e32421f53bb (diff)
downloadgit-d8a8488d569420c4e0a96a8df36b246d888e68d4.tar.gz
Add a "TEMPLATE DIRECTORY" section to git-init[1].
Create a more inoformative section to describe template directory and refer to it in config.txt and with the '--template' option of git-init and git-clone commands. Signed-off-by: Steven Drake <sdrake@xnet.co.nz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-init.txt')
-rw-r--r--Documentation/git-init.txt29
1 files changed, 21 insertions, 8 deletions
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 7ee102da48..246b07ebf9 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -28,14 +28,8 @@ current working directory.
--template=<template_directory>::
-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
-extensible.
+Specify the directory from which templates will be used. (See the "TEMPLATE
+DIRECTORY" section below.)
--shared[={false|true|umask|group|all|world|everybody|0xxx}]::
@@ -106,6 +100,25 @@ of the repository, such as installing the default hooks and
setting the configuration variables. The old name is retained
for backward compatibility reasons.
+TEMPLATE DIRECTORY
+------------------
+
+The template directory contains files and directories that will be copied to
+the `$GIT_DIR` after it is created.
+
+The template directory used will (in order):
+
+ - The argument given with the `--template` option.
+
+ - The contents of the `$GIT_TEMPLATE_DIR` environment variable.
+
+ - The `init.templatedir` configuration variable.
+
+ - The default template directory: `/usr/share/git-core/templates`.
+
+The default template directory includes some directory structure, some
+suggested "exclude patterns", and copies of sample "hook" files.
+The suggested patterns and hook files are all modifiable and extensible.
EXAMPLES
--------