Skip to content

Commit

Permalink
Autogenerated HTML docs for v1.5.0-rc1
Browse files Browse the repository at this point in the history
  • Loading branch information
Junio C Hamano committed Jan 12, 2007
1 parent 617d8c4 commit 91f77a0
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 211 deletions.
115 changes: 3 additions & 112 deletions git-init-db.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,123 +274,14 @@ <h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>git-init-db</em> [--template=&lt;template_directory&gt;] [--shared[=&lt;permissions&gt;]]</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<dl>
<dt>
--template=&lt;template_directory&gt;
</dt>
<dd>
<p>
Provide the directory from which templates will be used. The default template
directory is <tt>/usr/share/git-core/templates</tt>.
</p>
<p>When specified, <tt>&lt;template_directory&gt;</tt> 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.</p>
</dd>
<dt>
--shared[={false|true|umask|group|all|world|everybody}]
</dt>
<dd>
<p>
Specify that the git repository is to be shared amongst several users. This
allows users belonging to the same group to push into that
repository. When specified, the config variable "core.sharedRepository" is
set so that files and directories under <tt>$GIT_DIR</tt> are created with the
requested permissions. When not specified, git will use permissions reported
by umask(2).
</p>
<p>The option can have the following values, defaulting to <em>group</em> if no value
is given:</p>
<ul>
<li>
<p>
<em>umask</em> (or <em>false</em>): Use permissions reported by umask(2). The default,
when <tt>--shared</tt> is not specified.
</p>
</li>
<li>
<p>
<em>group</em> (or <em>true</em>): Make the repository group-writable, (and g+sx, since
the git group may be not the primary group of all users).
</p>
</li>
<li>
<p>
<em>all</em> (or <em>world</em> or <em>everybody</em>): Same as <em>group</em>, but make the repository
readable by all users.
</p>
<p>By default, the configuration flag receive.denyNonFastforward is enabled
in shared repositories, so that you cannot force a non fast-forwarding push
into it.</p>
</li>
</ul>
</dd>
</dl>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>This command creates an empty git repository - basically a <tt>.git</tt> directory
with subdirectories for <tt>objects</tt>, <tt>refs/heads</tt>, <tt>refs/tags</tt>, and
template files.
An initial <tt>HEAD</tt> file that references the HEAD of the master branch
is also created.</p>
<p>If the <tt>$GIT_DIR</tt> environment variable is set then it specifies a path
to use instead of <tt>./.git</tt> for the base of the repository.</p>
<p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>
environment variable then the sha1 directories are created underneath -
otherwise the default <tt>$GIT_DIR/objects</tt> directory is used.</p>
<p>Running <tt>git-init-db</tt> in an existing repository is safe. It will not overwrite
things that are already there. The primary reason for rerunning <tt>git-init-db</tt>
is to pick up newly added templates.</p>
<p>Note that <tt>git-init</tt> is the same as <tt>git-init-db</tt>.</p>
</div>
<h2>EXAMPLES</h2>
<div class="sectionbody">
<dl>
<dt>
Start a new git repository for an existing code base
</dt>
<dd>
<div class="listingblock">
<div class="content">
<pre><tt>$ cd /path/to/my/codebase
$ git-init-db <b>(1)</b>
$ git-add . <b>(2)</b></tt></pre>
</div></div>
<ol>
<li>
<p>
prepare /path/to/my/codebase/.git directory
</p>
</li>
<li>
<p>
add all existing file to the index
</p>
</li>
</ol>
</dd>
</dl>
</div>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
<p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
</div>
<h2>GIT</h2>
<div class="sectionbody">
<p>Part of the <a href="git.html">git(7)</a> suite</p>
<p>This is a synonym for <a href="git-init.html">git-init(1)</a>. Please refer to the
documentation of that command.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 08-Jan-2007 06:53:18 UTC
Last updated 12-Jan-2007 02:43:35 UTC
</div>
</div>
</body>
Expand Down
91 changes: 2 additions & 89 deletions git-init-db.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,96 +11,9 @@ SYNOPSIS
'git-init-db' [--template=<template_directory>] [--shared[=<permissions>]]


OPTIONS
-------

--

--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.

--shared[={false|true|umask|group|all|world|everybody}]::

Specify that the git repository is to be shared amongst several users. This
allows users belonging to the same group to push into that
repository. When specified, the config variable "core.sharedRepository" is
set so that files and directories under `$GIT_DIR` are created with the
requested permissions. When not specified, git will use permissions reported
by umask(2).

The option can have the following values, defaulting to 'group' if no value
is given:

- 'umask' (or 'false'): Use permissions reported by umask(2). The default,
when `--shared` is not specified.

- 'group' (or 'true'): Make the repository group-writable, (and g+sx, since
the git group may be not the primary group of all users).

- 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository
readable by all users.

By default, the configuration flag receive.denyNonFastforward is enabled
in shared repositories, so that you cannot force a non fast-forwarding push
into it.

--


DESCRIPTION
-----------
This command creates an empty git repository - basically a `.git` directory
with subdirectories for `objects`, `refs/heads`, `refs/tags`, and
template files.
An initial `HEAD` file that references the HEAD of the master branch
is also created.

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`
environment variable then the sha1 directories are created underneath -
otherwise the default `$GIT_DIR/objects` directory is used.

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.

Note that `git-init` is the same as `git-init-db`.


EXAMPLES
--------

Start a new git repository for an existing code base::
+
----------------
$ cd /path/to/my/codebase
$ git-init-db <1>
$ git-add . <2>
----------------
+
<1> prepare /path/to/my/codebase/.git directory
<2> add all existing file to the index


Author
------
Written by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT
---
Part of the gitlink:git[7] suite
This is a synonym for gitlink:git-init[1]. Please refer to the
documentation of that command.

25 changes: 16 additions & 9 deletions git-init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,23 +256,23 @@
padding-left: 0.5em;
}
</style>
<title>git-init-db(1)</title>
<title>git-init(1)</title>
</head>
<body>
<div id="header">
<h1>
git-init-db(1) Manual Page
git-init(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-init-db -
<p>git-init -
Creates an empty git repository
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>git-init-db</em> [--template=&lt;template_directory&gt;] [--shared[=&lt;permissions&gt;]]</p>
<p><em>git-init</em> [--template=&lt;template_directory&gt;] [--shared[=&lt;permissions&gt;]]</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
Expand Down Expand Up @@ -343,10 +343,17 @@ <h2>DESCRIPTION</h2>
<p>If the object storage directory is specified via the <tt>$GIT_OBJECT_DIRECTORY</tt>
environment variable then the sha1 directories are created underneath -
otherwise the default <tt>$GIT_DIR/objects</tt> directory is used.</p>
<p>Running <tt>git-init-db</tt> in an existing repository is safe. It will not overwrite
things that are already there. The primary reason for rerunning <tt>git-init-db</tt>
<p>Running <tt>git-init</tt> in an existing repository is safe. It will not overwrite
things that are already there. The primary reason for rerunning <tt>git-init</tt>
is to pick up newly added templates.</p>
<p>Note that <tt>git-init</tt> is the same as <tt>git-init-db</tt>.</p>
<p>Note that <tt>git-init</tt> is the same as <tt>git-init-db</tt>. The command
was primarily meant to initialize the object database, but over
time it has become responsible for setting up the other aspects
of the repository, such as installing the default hooks and
setting the configuration variables. The old name is retained
because people are so used to it and many existing documents
refer to it that way, and this will not change for some time to
come.</p>
</div>
<h2>EXAMPLES</h2>
<div class="sectionbody">
Expand All @@ -358,7 +365,7 @@ <h2>EXAMPLES</h2>
<div class="listingblock">
<div class="content">
<pre><tt>$ cd /path/to/my/codebase
$ git-init-db <b>(1)</b>
$ git-init <b>(1)</b>
$ git-add . <b>(2)</b></tt></pre>
</div></div>
<ol>
Expand Down Expand Up @@ -390,7 +397,7 @@ <h2>GIT</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 11-Jan-2007 00:35:44 UTC
Last updated 12-Jan-2007 02:43:35 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 91f77a0

Please sign in to comment.