Autogenerated HTML docs for v1.3.1-g7464
[git.git] / git-init-db.html
index dead1b6..67e5621 100644 (file)
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 7.0.1" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
 <style type="text/css">\r
 /* Debug borders */\r
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
@@ -272,7 +272,7 @@ git-init-db(1) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-init-db</em> [--template=&lt;template_directory&gt;]</p>\r
+<p><em>git-init-db</em> [--template=&lt;template_directory&gt;] [--shared]</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -282,22 +282,44 @@ git-init-db(1) Manual Page
 </dt>\r
 <dd>\r
 <p>\r
-        Provide the directory in from which templates will be used.\r
+        Provide the directory from which templates will be used.\r
+        The default template directory is <tt>/usr/share/git-core/templates</tt>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--shared\r
+</dt>\r
+<dd>\r
+<p>\r
+        Specify that the git repository is to be shared amongst several users.\r
 </p>\r
 </dd>\r
 </dl>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>This simply creates an empty git repository - basically a <tt>.git</tt> directory\r
-and <tt>.git/object/??/</tt>, <tt>.git/refs/heads</tt> and <tt>.git/refs/tags</tt> directories,\r
-and links <tt>.git/HEAD</tt> symbolically to <tt>.git/refs/heads/master</tt>.</p>\r
+<p>This command creates an empty git repository - basically a <tt>.git</tt> directory\r
+with subdirectories for <tt>objects</tt>, <tt>refs/heads</tt>, <tt>refs/tags</tt>, and\r
+templated files.\r
+An initial <tt>HEAD</tt> file that references the HEAD of the master branch\r
+is also created.</p>\r
+<p>If <tt>--template=&lt;template_directory&gt;</tt> is specified, <tt>&lt;template_directory&gt;</tt>\r
+is used as the source of the template files rather than the default.\r
+The template files include some directory structure, some suggested\r
+"exclude patterns", and copies of non-executing "hook" files.  The\r
+suggested patterns and hook files are all modifiable and extensible.</p>\r
 <p>If the <tt>$GIT_DIR</tt> environment variable is set then it specifies a path\r
 to use instead of <tt>./.git</tt> for the base of the repository.</p>\r
 <p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>\r
 environment variable then the sha1 directories are created underneath -\r
 otherwise the default <tt>$GIT_DIR/objects</tt> directory is used.</p>\r
-<p><tt>git-init-db</tt> won't hurt an existing repository.</p>\r
+<p>A shared repository allows users belonging to the same group to push into that\r
+repository. When specifying <tt>--shared</tt> the config variable "core.sharedRepository"\r
+is set to <em>true</em> so that directories under <tt>$GIT_DIR</tt> are made group writable\r
+(and g+sx, since the git group may be not the primary group of all users).</p>\r
+<p>Running <tt>git-init-db</tt> in an existing repository is safe. It will not overwrite\r
+things that are already there. The primary reason for rerunning <tt>git-init-db</tt>\r
+is to pick up newly added templates.</p>\r
 </div>\r
 <h2>EXAMPLES</h2>\r
 <div class="sectionbody">\r
@@ -309,12 +331,21 @@ Start a new git repository for an existing code base
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>$ cd /path/to/my/codebase\r
-$ git-init-db <b>(1)</b>\r
-$ git-add . <b>(2)</b>\r
-\r
-<b>(1)</b> prepare /path/to/my/codebase/.git directory\r
-<b>(2)</b> add all existing file to the index</tt></pre>\r
+$ git-init-db   <b>(1)</b>\r
+$ git-add .     <b>(2)</b></tt></pre>\r
 </div></div>\r
+<ol>\r
+<li>\r
+<p>\r
+prepare /path/to/my/codebase/.git directory\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+add all existing file to the index\r
+</p>\r
+</li>\r
+</ol>\r
 </dd>\r
 </dl>\r
 </div>\r
@@ -332,7 +363,7 @@ $ git-add . <b>(2)</b>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 27-Dec-2005 00:16:13 PDT\r
+Last updated 29-Apr-2006 07:01:33 UTC\r
 </div>\r
 </div>\r
 </body>\r