summaryrefslogtreecommitdiff
path: root/Documentation/git-init.txt
blob: b48c31289923345d8f50342780d30dbcb4e01399 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
git-init(1)
===========
 
NAME
----
git-init - Create an empty git repository or reinitialize an existing one
 
 
SYNOPSIS
--------
'git-init' [-q | --quiet] [--bare] [--template=<template_directory>] [--shared[=<permissions>]]
 
 
OPTIONS
-------
 
--
 
-q, \--quiet::
 
Only print error and warning messages, all other output will be suppressed.
 
--bare::
 
Create a bare repository. If GIT_DIR environment is not set, it is set to the
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.
 
--shared[={false|true|umask|group|all|world|everybody|0xxx}]::
 
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.
 
 - '0xxx': '0xxx' is an octal number and each file will have mode '0xxx'
   Any option except 'umask' can be set using this option. '0xxx' will
   override users umask(2) value, and thus, users with a safe umask (0077)
   can use this option. '0640' will create a repository which is group-readable
   but not writable. '0660' is equivalent to 'group'.
 
By default, the configuration flag receive.denyNonFastForwards 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` in an existing repository is safe. It will not overwrite
things that are already there. The primary reason for rerunning `git-init`
is to pick up newly added templates.
 
Note that `git-init` is the same as `git-init-db`.  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
for backward compatibility reasons.
 
 
EXAMPLES
--------
 
Start a new git repository for an existing code base::
+
----------------
$ cd /path/to/my/codebase
$ git-init      <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 linkgit:git[7] suite