summaryrefslogtreecommitdiff
path: root/Documentation/git-init-db.txt
diff options
context:
space:
mode:
authorJon Loeliger <jdl@freescale.com>2005-12-06 05:13:03 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-12-06 05:47:16 (GMT)
commit61f693bd5a2ab4d830aad6fce0a1c70863f38009 (patch)
tree896b9aead36f45bffcfb86f6d4ef9753b4a4a876 /Documentation/git-init-db.txt
parent23c99d84601316c1e51ebc1f0b9bec5cddd011fb (diff)
downloadgit-61f693bd5a2ab4d830aad6fce0a1c70863f38009.zip
git-61f693bd5a2ab4d830aad6fce0a1c70863f38009.tar.gz
git-61f693bd5a2ab4d830aad6fce0a1c70863f38009.tar.bz2
Added documentation for few missing options.
More $ shell prompts in examples. Minor English grammar improvements. Added a few "See Also"s. Use back-ticks on more command examples. Signed-off-by: Jon Loeliger <jdl@freescale.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-init-db.txt')
-rw-r--r--Documentation/git-init-db.txt27
1 files changed, 23 insertions, 4 deletions
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index ef1826a..4486f0c 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -8,7 +8,14 @@ git-init-db - Creates an empty git repository
SYNOPSIS
--------
-'git-init-db'
+'git-init-db' [--template=<template_directory>]
+
+
+OPTIONS
+-------
+--template=<template_directory>::
+ Provide the directory in from which templates will be used.
+
DESCRIPTION
-----------
@@ -16,14 +23,26 @@ 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`.
-If the 'GIT_DIR' environment variable is set then it specifies a path
+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'
+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.
-"git-init-db" won't hurt an existing repository.
+`git-init-db` won't hurt an existing repository.
+
+
+EXAMPLES
+--------
+
+Start a new git repository for an existing code base::
++
+----------------
+$ cd /path/to/my/codebase
+$ git-init-db
+----------------
+
Author