]>
Commit | Line | Data |
---|---|---|
9e1f0a85 | 1 | git(1) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
8b70004b | 11 | [verse] |
89a56bfb | 12 | 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path] |
b0fa7ab5 | 13 | [-p|--paginate|--no-pager] [--no-replace-objects] |
892c41b9 ML |
14 | [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] |
15 | [--help] COMMAND [ARGS] | |
2cf565c5 DG |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
23091e95 BF |
19 | Git is a fast, scalable, distributed revision control system with an |
20 | unusually rich command set that provides both high-level operations | |
21 | and full access to internals. | |
22 | ||
6998e4db | 23 | See linkgit:gittutorial[7] to get started, then see |
23091e95 BF |
24 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and |
25 | "man git-commandname" for documentation of each command. CVS users may | |
6998e4db JN |
26 | also want to read linkgit:gitcvs-migration[7]. See |
27 | the link:user-manual.html[Git User's Manual] for a more in-depth | |
a1dc34fa | 28 | introduction. |
cb22bc44 | 29 | |
4514ad4f | 30 | The COMMAND is either a name of a Git command (see below) or an alias |
5162e697 | 31 | as defined in the configuration file (see linkgit:git-config[1]). |
4514ad4f | 32 | |
34b604af JA |
33 | Formatted and hyperlinked version of the latest git |
34 | documentation can be viewed at | |
35 | `http://www.kernel.org/pub/software/scm/git/docs/`. | |
36 | ||
26cfcfbf JH |
37 | ifdef::stalenotes[] |
38 | [NOTE] | |
39 | ============ | |
26cfcfbf | 40 | |
2ff3f61a JH |
41 | You are reading the documentation for the latest (possibly |
42 | unreleased) version of git, that is available from 'master' | |
43 | branch of the `git.git` repository. | |
44 | Documentation for older releases are available here: | |
43a8e4fe | 45 | |
e923eaeb JH |
46 | * link:v1.7.0/git.html[documentation for release 1.7.0] |
47 | ||
48 | * release notes for | |
49 | link:RelNotes-1.7.0.txt[1.7.0]. | |
50 | ||
4133fd25 | 51 | * link:v1.6.6.2/git.html[documentation for release 1.6.6.2] |
902f2353 JH |
52 | |
53 | * release notes for | |
4133fd25 | 54 | link:RelNotes-1.6.6.2.txt[1.6.6.2], |
9504f3d3 | 55 | link:RelNotes-1.6.6.1.txt[1.6.6.1], |
902f2353 JH |
56 | link:RelNotes-1.6.6.txt[1.6.6]. |
57 | ||
35eabd15 | 58 | * link:v1.6.5.8/git.html[documentation for release 1.6.5.8] |
78d553b7 JH |
59 | |
60 | * release notes for | |
35eabd15 | 61 | link:RelNotes-1.6.5.8.txt[1.6.5.8], |
527b9d70 | 62 | link:RelNotes-1.6.5.7.txt[1.6.5.7], |
9861b644 | 63 | link:RelNotes-1.6.5.6.txt[1.6.5.6], |
aa031314 | 64 | link:RelNotes-1.6.5.5.txt[1.6.5.5], |
eefe19fb | 65 | link:RelNotes-1.6.5.4.txt[1.6.5.4], |
080cbc12 | 66 | link:RelNotes-1.6.5.3.txt[1.6.5.3], |
6c0efa2a | 67 | link:RelNotes-1.6.5.2.txt[1.6.5.2], |
b142da2a | 68 | link:RelNotes-1.6.5.1.txt[1.6.5.1], |
78d553b7 JH |
69 | link:RelNotes-1.6.5.txt[1.6.5]. |
70 | ||
cb572206 | 71 | * link:v1.6.4.4/git.html[documentation for release 1.6.4.4] |
0a53e9dd JH |
72 | |
73 | * release notes for | |
cb572206 | 74 | link:RelNotes-1.6.4.4.txt[1.6.4.4], |
7fb6bcff | 75 | link:RelNotes-1.6.4.3.txt[1.6.4.3], |
82c3e210 | 76 | link:RelNotes-1.6.4.2.txt[1.6.4.2], |
d9b9784f | 77 | link:RelNotes-1.6.4.1.txt[1.6.4.1], |
0a53e9dd JH |
78 | link:RelNotes-1.6.4.txt[1.6.4]. |
79 | ||
441b40d8 | 80 | * link:v1.6.3.4/git.html[documentation for release 1.6.3.4] |
6096d759 JH |
81 | |
82 | * release notes for | |
441b40d8 | 83 | link:RelNotes-1.6.3.4.txt[1.6.3.4], |
e16a4779 | 84 | link:RelNotes-1.6.3.3.txt[1.6.3.3], |
6096d759 JH |
85 | link:RelNotes-1.6.3.2.txt[1.6.3.2], |
86 | link:RelNotes-1.6.3.1.txt[1.6.3.1], | |
87 | link:RelNotes-1.6.3.txt[1.6.3]. | |
a95148de JH |
88 | |
89 | * release notes for | |
f01f1099 JH |
90 | link:RelNotes-1.6.2.5.txt[1.6.2.5], |
91 | link:RelNotes-1.6.2.4.txt[1.6.2.4], | |
c965c029 | 92 | link:RelNotes-1.6.2.3.txt[1.6.2.3], |
54a47493 | 93 | link:RelNotes-1.6.2.2.txt[1.6.2.2], |
de769780 | 94 | link:RelNotes-1.6.2.1.txt[1.6.2.1], |
a95148de JH |
95 | link:RelNotes-1.6.2.txt[1.6.2]. |
96 | ||
621f1b4b | 97 | * link:v1.6.1.3/git.html[documentation for release 1.6.1.3] |
8104ebfe JH |
98 | |
99 | * release notes for | |
621f1b4b JH |
100 | link:RelNotes-1.6.1.3.txt[1.6.1.3], |
101 | link:RelNotes-1.6.1.2.txt[1.6.1.2], | |
c42b1ad9 | 102 | link:RelNotes-1.6.1.1.txt[1.6.1.1], |
8104ebfe JH |
103 | link:RelNotes-1.6.1.txt[1.6.1]. |
104 | ||
efe05b01 | 105 | * link:v1.6.0.6/git.html[documentation for release 1.6.0.6] |
ea02eef0 JH |
106 | |
107 | * release notes for | |
efe05b01 | 108 | link:RelNotes-1.6.0.6.txt[1.6.0.6], |
f371d3ea | 109 | link:RelNotes-1.6.0.5.txt[1.6.0.5], |
171d7661 JH |
110 | link:RelNotes-1.6.0.4.txt[1.6.0.4], |
111 | link:RelNotes-1.6.0.3.txt[1.6.0.3], | |
97a7a82f JH |
112 | link:RelNotes-1.6.0.2.txt[1.6.0.2], |
113 | link:RelNotes-1.6.0.1.txt[1.6.0.1], | |
ea02eef0 JH |
114 | link:RelNotes-1.6.0.txt[1.6.0]. |
115 | ||
efe05b01 | 116 | * link:v1.5.6.6/git.html[documentation for release 1.5.6.6] |
e449f105 JH |
117 | |
118 | * release notes for | |
efe05b01 | 119 | link:RelNotes-1.5.6.6.txt[1.5.6.6], |
781c1834 | 120 | link:RelNotes-1.5.6.5.txt[1.5.6.5], |
09651dd8 JH |
121 | link:RelNotes-1.5.6.4.txt[1.5.6.4], |
122 | link:RelNotes-1.5.6.3.txt[1.5.6.3], | |
123 | link:RelNotes-1.5.6.2.txt[1.5.6.2], | |
124 | link:RelNotes-1.5.6.1.txt[1.5.6.1], | |
e636106c | 125 | link:RelNotes-1.5.6.txt[1.5.6]. |
e449f105 | 126 | |
efe05b01 | 127 | * link:v1.5.5.6/git.html[documentation for release 1.5.5.6] |
1d2375dd JH |
128 | |
129 | * release notes for | |
efe05b01 JH |
130 | link:RelNotes-1.5.5.6.txt[1.5.5.6], |
131 | link:RelNotes-1.5.5.5.txt[1.5.5.5], | |
7064ca51 | 132 | link:RelNotes-1.5.5.4.txt[1.5.5.4], |
28bc3022 | 133 | link:RelNotes-1.5.5.3.txt[1.5.5.3], |
2d3922dc | 134 | link:RelNotes-1.5.5.2.txt[1.5.5.2], |
66aaa2fc | 135 | link:RelNotes-1.5.5.1.txt[1.5.5.1], |
1d2375dd JH |
136 | link:RelNotes-1.5.5.txt[1.5.5]. |
137 | ||
efe05b01 | 138 | * link:v1.5.4.7/git.html[documentation for release 1.5.4.7] |
6ce8e44a JH |
139 | |
140 | * release notes for | |
efe05b01 JH |
141 | link:RelNotes-1.5.4.7.txt[1.5.4.7], |
142 | link:RelNotes-1.5.4.6.txt[1.5.4.6], | |
803d5158 | 143 | link:RelNotes-1.5.4.5.txt[1.5.4.5], |
ad416ed4 | 144 | link:RelNotes-1.5.4.4.txt[1.5.4.4], |
923d44ae | 145 | link:RelNotes-1.5.4.3.txt[1.5.4.3], |
cf5c51ef | 146 | link:RelNotes-1.5.4.2.txt[1.5.4.2], |
ecb879f8 | 147 | link:RelNotes-1.5.4.1.txt[1.5.4.1], |
6ce8e44a JH |
148 | link:RelNotes-1.5.4.txt[1.5.4]. |
149 | ||
e708af6e | 150 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
5587cac2 JH |
151 | |
152 | * release notes for | |
e708af6e | 153 | link:RelNotes-1.5.3.8.txt[1.5.3.8], |
b52e985a | 154 | link:RelNotes-1.5.3.7.txt[1.5.3.7], |
4a44b9ea | 155 | link:RelNotes-1.5.3.6.txt[1.5.3.6], |
afc05f9f | 156 | link:RelNotes-1.5.3.5.txt[1.5.3.5], |
58ba4f6a | 157 | link:RelNotes-1.5.3.4.txt[1.5.3.4], |
326df26d | 158 | link:RelNotes-1.5.3.3.txt[1.5.3.3], |
077d6f72 | 159 | link:RelNotes-1.5.3.2.txt[1.5.3.2], |
8d863c98 JH |
160 | link:RelNotes-1.5.3.1.txt[1.5.3.1], |
161 | link:RelNotes-1.5.3.txt[1.5.3]. | |
b6e4db6a | 162 | |
e636106c JH |
163 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
164 | ||
aba170cd | 165 | * release notes for |
da899deb | 166 | link:RelNotes-1.5.2.5.txt[1.5.2.5], |
baafd6e7 | 167 | link:RelNotes-1.5.2.4.txt[1.5.2.4], |
444649e5 | 168 | link:RelNotes-1.5.2.3.txt[1.5.2.3], |
3e48af38 JH |
169 | link:RelNotes-1.5.2.2.txt[1.5.2.2], |
170 | link:RelNotes-1.5.2.1.txt[1.5.2.1], | |
aba170cd JH |
171 | link:RelNotes-1.5.2.txt[1.5.2]. |
172 | ||
173 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] | |
174 | ||
175 | * release notes for | |
176 | link:RelNotes-1.5.1.6.txt[1.5.1.6], | |
177 | link:RelNotes-1.5.1.5.txt[1.5.1.5], | |
2ff3f61a JH |
178 | link:RelNotes-1.5.1.4.txt[1.5.1.4], |
179 | link:RelNotes-1.5.1.3.txt[1.5.1.3], | |
180 | link:RelNotes-1.5.1.2.txt[1.5.1.2], | |
181 | link:RelNotes-1.5.1.1.txt[1.5.1.1], | |
182 | link:RelNotes-1.5.1.txt[1.5.1]. | |
183 | ||
184 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] | |
185 | ||
aba170cd JH |
186 | * release notes for |
187 | link:RelNotes-1.5.0.7.txt[1.5.0.7], | |
2ff3f61a JH |
188 | link:RelNotes-1.5.0.6.txt[1.5.0.6], |
189 | link:RelNotes-1.5.0.5.txt[1.5.0.5], | |
190 | link:RelNotes-1.5.0.3.txt[1.5.0.3], | |
191 | link:RelNotes-1.5.0.2.txt[1.5.0.2], | |
192 | link:RelNotes-1.5.0.1.txt[1.5.0.1], | |
193 | link:RelNotes-1.5.0.txt[1.5.0]. | |
194 | ||
195 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], | |
196 | link:v1.3.3/git.html[1.3.3], | |
197 | link:v1.2.6/git.html[1.2.6], | |
198 | link:v1.0.13/git.html[1.0.13]. | |
26cfcfbf JH |
199 | |
200 | ============ | |
201 | ||
202 | endif::stalenotes[] | |
203 | ||
cb22bc44 AE |
204 | OPTIONS |
205 | ------- | |
206 | --version:: | |
a87cd02c | 207 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
208 | |
209 | --help:: | |
a87cd02c | 210 | Prints the synopsis and a list of the most commonly used |
0f6f195b CC |
211 | commands. If the option '--all' or '-a' is given then all |
212 | available commands are printed. If a git command is named this | |
213 | option will bring up the manual page for that command. | |
45533d26 CC |
214 | + |
215 | Other options are available to control how the manual page is | |
5162e697 | 216 | displayed. See linkgit:git-help[1] for more information, |
db5d6666 JN |
217 | because `git --help ...` is converted internally into `git |
218 | help ...`. | |
cb22bc44 AE |
219 | |
220 | --exec-path:: | |
a87cd02c | 221 | Path to wherever your core git programs are installed. |
cb22bc44 | 222 | This can also be controlled by setting the GIT_EXEC_PATH |
56992f76 | 223 | environment variable. If no path is given, 'git' will print |
cb22bc44 AE |
224 | the current setting and then exit. |
225 | ||
89a56bfb MH |
226 | --html-path:: |
227 | Print the path to wherever your git HTML documentation is installed | |
228 | and exit. | |
229 | ||
3240240f SB |
230 | -p:: |
231 | --paginate:: | |
6acbcb92 JS |
232 | Pipe all output into 'less' (or if set, $PAGER). |
233 | ||
463a849d MM |
234 | --no-pager:: |
235 | Do not pipe git output into a pager. | |
236 | ||
6acbcb92 JS |
237 | --git-dir=<path>:: |
238 | Set the path to the repository. This can also be controlled by | |
302cc11a LY |
239 | setting the GIT_DIR environment variable. It can be an absolute |
240 | path or relative path to current working directory. | |
6acbcb92 | 241 | |
892c41b9 ML |
242 | --work-tree=<path>:: |
243 | Set the path to the working tree. The value will not be | |
244 | used in combination with repositories found automatically in | |
245 | a .git directory (i.e. $GIT_DIR is not set). | |
246 | This can also be controlled by setting the GIT_WORK_TREE | |
247 | environment variable and the core.worktree configuration | |
302cc11a LY |
248 | variable. It can be an absolute path or relative path to |
249 | the directory specified by --git-dir or GIT_DIR. | |
250 | Note: If --git-dir or GIT_DIR are specified but none of | |
251 | --work-tree, GIT_WORK_TREE and core.worktree is specified, | |
252 | the current working directory is regarded as the top directory | |
253 | of your working tree. | |
892c41b9 | 254 | |
6acbcb92 | 255 | --bare:: |
9277d602 JH |
256 | Treat the repository as a bare repository. If GIT_DIR |
257 | environment is not set, it is set to the current working | |
258 | directory. | |
259 | ||
b0fa7ab5 CC |
260 | --no-replace-objects:: |
261 | Do not use replacement refs to replace git objects. See | |
262 | linkgit:git-replace[1] for more information. | |
263 | ||
9755afbd | 264 | |
23091e95 BF |
265 | FURTHER DOCUMENTATION |
266 | --------------------- | |
9755afbd | 267 | |
23091e95 BF |
268 | See the references above to get started using git. The following is |
269 | probably more detail than necessary for a first-time user. | |
8db9307c | 270 | |
40dac517 | 271 | The link:user-manual.html#git-concepts[git concepts chapter of the |
6998e4db | 272 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
40dac517 | 273 | introductions to the underlying git architecture. |
e6fc2346 | 274 | |
801a011d TR |
275 | See linkgit:gitworkflows[7] for an overview of recommended workflows. |
276 | ||
23091e95 BF |
277 | See also the link:howto-index.html[howto] documents for some useful |
278 | examples. | |
9755afbd | 279 | |
6998e4db JN |
280 | The internals are documented in the |
281 | link:technical/api-index.html[GIT API documentation]. | |
530e741c | 282 | |
23091e95 BF |
283 | GIT COMMANDS |
284 | ------------ | |
9755afbd | 285 | |
23091e95 BF |
286 | We divide git into high level ("porcelain") commands and low level |
287 | ("plumbing") commands. | |
8b15e2fb | 288 | |
23091e95 BF |
289 | High-level commands (porcelain) |
290 | ------------------------------- | |
291 | ||
292 | We separate the porcelain commands into the main commands and some | |
293 | ancillary user utilities. | |
294 | ||
295 | Main porcelain commands | |
296 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 297 | |
377e8139 | 298 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 299 | |
90933efb | 300 | Ancillary Commands |
23091e95 | 301 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
302 | Manipulators: |
303 | ||
377e8139 | 304 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 305 | |
90933efb | 306 | Interrogators: |
204ee6a9 | 307 | |
377e8139 | 308 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 309 | |
89bf2077 JH |
310 | |
311 | Interacting with Others | |
312 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
313 | ||
314 | These commands are to interact with foreign SCM and with other | |
315 | people via patch over e-mail. | |
316 | ||
317 | include::cmds-foreignscminterface.txt[] | |
318 | ||
319 | ||
b1f33d62 RR |
320 | Low-level commands (plumbing) |
321 | ----------------------------- | |
322 | ||
323 | Although git includes its | |
324 | own porcelain layer, its low-level commands are sufficient to support | |
325 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
326 | might start by reading about linkgit:git-update-index[1] and |
327 | linkgit:git-read-tree[1]. | |
b1f33d62 | 328 | |
89bf2077 JH |
329 | The interface (input, output, set of options and the semantics) |
330 | to these low-level commands are meant to be a lot more stable | |
331 | than Porcelain level commands, because these commands are | |
332 | primarily for scripted use. The interface to Porcelain commands | |
333 | on the other hand are subject to change in order to improve the | |
334 | end user experience. | |
335 | ||
336 | The following description divides | |
337 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
338 | the repository, index, and working tree), commands that interrogate and |
339 | compare objects, and commands that move objects and references between | |
340 | repositories. | |
341 | ||
89bf2077 | 342 | |
b1f33d62 RR |
343 | Manipulation commands |
344 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 345 | |
377e8139 | 346 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
347 | |
348 | ||
349 | Interrogation commands | |
350 | ~~~~~~~~~~~~~~~~~~~~~~ | |
351 | ||
377e8139 | 352 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
353 | |
354 | In general, the interrogate commands do not touch the files in | |
355 | the working tree. | |
356 | ||
357 | ||
358 | Synching repositories | |
359 | ~~~~~~~~~~~~~~~~~~~~~ | |
360 | ||
377e8139 | 361 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 362 | |
57f6ec02 | 363 | The following are helper commands used by the above; end users |
89bf2077 JH |
364 | typically do not use them directly. |
365 | ||
366 | include::cmds-synchelpers.txt[] | |
367 | ||
368 | ||
369 | Internal helper commands | |
370 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
371 | ||
372 | These are internal helper commands used by other commands; end | |
373 | users typically do not use them directly. | |
374 | ||
375 | include::cmds-purehelpers.txt[] | |
376 | ||
b1f33d62 | 377 | |
5773c9f2 JH |
378 | Configuration Mechanism |
379 | ----------------------- | |
380 | ||
2fa090b6 | 381 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 | 382 | is used to hold per-repository configuration options. It is a |
addf88e4 | 383 | simple text file modeled after `.ini` format familiar to some |
5773c9f2 JH |
384 | people. Here is an example: |
385 | ||
386 | ------------ | |
387 | # | |
2fa090b6 | 388 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
389 | # |
390 | ||
391 | ; core variables | |
392 | [core] | |
393 | ; Don't trust file modes | |
394 | filemode = false | |
395 | ||
396 | ; user identity | |
397 | [user] | |
398 | name = "Junio C Hamano" | |
399 | email = "junkio@twinsun.com" | |
400 | ||
401 | ------------ | |
402 | ||
403 | Various commands read from the configuration file and adjust | |
404 | their operation accordingly. | |
405 | ||
406 | ||
6c84e2e0 | 407 | Identifier Terminology |
2cf565c5 DG |
408 | ---------------------- |
409 | <object>:: | |
2fa090b6 | 410 | Indicates the object name for any type of object. |
2cf565c5 DG |
411 | |
412 | <blob>:: | |
2fa090b6 | 413 | Indicates a blob object name. |
2cf565c5 DG |
414 | |
415 | <tree>:: | |
2fa090b6 | 416 | Indicates a tree object name. |
2cf565c5 DG |
417 | |
418 | <commit>:: | |
2fa090b6 | 419 | Indicates a commit object name. |
2cf565c5 DG |
420 | |
421 | <tree-ish>:: | |
2fa090b6 | 422 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
423 | command that takes a <tree-ish> argument ultimately wants to |
424 | operate on a <tree> object but automatically dereferences | |
425 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 426 | |
043d7605 TT |
427 | <commit-ish>:: |
428 | Indicates a commit or tag object name. A | |
429 | command that takes a <commit-ish> argument ultimately wants to | |
430 | operate on a <commit> object but automatically dereferences | |
431 | <tag> objects that point at a <commit>. | |
432 | ||
2cf565c5 DG |
433 | <type>:: |
434 | Indicates that an object type is required. | |
2fa090b6 | 435 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
436 | |
437 | <file>:: | |
2fa090b6 JH |
438 | Indicates a filename - almost always relative to the |
439 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 440 | |
c1bdacf9 DG |
441 | Symbolic Identifiers |
442 | -------------------- | |
90933efb | 443 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 444 | symbolic notation: |
c1bdacf9 DG |
445 | |
446 | HEAD:: | |
2fa090b6 JH |
447 | indicates the head of the current branch (i.e. the |
448 | contents of `$GIT_DIR/HEAD`). | |
449 | ||
c1bdacf9 | 450 | <tag>:: |
2fa090b6 JH |
451 | a valid tag 'name' |
452 | (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). | |
453 | ||
c1bdacf9 | 454 | <head>:: |
2fa090b6 JH |
455 | a valid head 'name' |
456 | (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). | |
457 | ||
d47107d8 | 458 | For a more complete list of ways to spell object names, see |
5162e697 | 459 | "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. |
d47107d8 | 460 | |
c1bdacf9 DG |
461 | |
462 | File/Directory Structure | |
463 | ------------------------ | |
c1bdacf9 | 464 | |
6998e4db | 465 | Please see the linkgit:gitrepository-layout[5] document. |
c1bdacf9 | 466 | |
6998e4db | 467 | Read linkgit:githooks[5] for more details about each hook. |
6250ad1e | 468 | |
c1bdacf9 | 469 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 470 | `$GIT_DIR`. |
c1bdacf9 | 471 | |
a1d4aa74 | 472 | |
2cf565c5 DG |
473 | Terminology |
474 | ----------- | |
6998e4db | 475 | Please see linkgit:gitglossary[7]. |
2cf565c5 DG |
476 | |
477 | ||
478 | Environment Variables | |
479 | --------------------- | |
480 | Various git commands use the following environment variables: | |
481 | ||
c1bdacf9 DG |
482 | The git Repository |
483 | ~~~~~~~~~~~~~~~~~~ | |
484 | These environment variables apply to 'all' core git commands. Nb: it | |
485 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 486 | git so take care if using Cogito etc. |
c1bdacf9 DG |
487 | |
488 | 'GIT_INDEX_FILE':: | |
489 | This environment allows the specification of an alternate | |
5f3aa197 LS |
490 | index file. If not specified, the default of `$GIT_DIR/index` |
491 | is used. | |
c1bdacf9 DG |
492 | |
493 | 'GIT_OBJECT_DIRECTORY':: | |
494 | If the object storage directory is specified via this | |
495 | environment variable then the sha1 directories are created | |
496 | underneath - otherwise the default `$GIT_DIR/objects` | |
497 | directory is used. | |
498 | ||
499 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
500 | Due to the immutable nature of git objects, old objects can be | |
501 | archived into shared, read-only directories. This variable | |
80ba074f JS |
502 | specifies a ":" separated (on Windows ";" separated) list |
503 | of git object directories which can be used to search for git | |
504 | objects. New objects will not be written to these directories. | |
c1bdacf9 DG |
505 | |
506 | 'GIT_DIR':: | |
2fa090b6 JH |
507 | If the 'GIT_DIR' environment variable is set then it |
508 | specifies a path to use instead of the default `.git` | |
509 | for the base of the repository. | |
c1bdacf9 | 510 | |
892c41b9 ML |
511 | 'GIT_WORK_TREE':: |
512 | Set the path to the working tree. The value will not be | |
513 | used in combination with repositories found automatically in | |
514 | a .git directory (i.e. $GIT_DIR is not set). | |
515 | This can also be controlled by the '--work-tree' command line | |
516 | option and the core.worktree configuration variable. | |
517 | ||
0454dd93 DR |
518 | 'GIT_CEILING_DIRECTORIES':: |
519 | This should be a colon-separated list of absolute paths. | |
520 | If set, it is a list of directories that git should not chdir | |
521 | up into while looking for a repository directory. | |
522 | It will not exclude the current working directory or | |
523 | a GIT_DIR set on the command line or in the environment. | |
524 | (Useful for excluding slow-loading network directories.) | |
525 | ||
c1bdacf9 DG |
526 | git Commits |
527 | ~~~~~~~~~~~ | |
528 | 'GIT_AUTHOR_NAME':: | |
529 | 'GIT_AUTHOR_EMAIL':: | |
530 | 'GIT_AUTHOR_DATE':: | |
531 | 'GIT_COMMITTER_NAME':: | |
532 | 'GIT_COMMITTER_EMAIL':: | |
4e58bf97 | 533 | 'GIT_COMMITTER_DATE':: |
28a94f88 | 534 | 'EMAIL':: |
5162e697 | 535 | see linkgit:git-commit-tree[1] |
c1bdacf9 DG |
536 | |
537 | git Diffs | |
538 | ~~~~~~~~~ | |
d81ed1b5 | 539 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
540 | Only valid setting is "--unified=??" or "-u??" to set the |
541 | number of context lines shown when a unified diff is created. | |
542 | This takes precedence over any "-U" or "--unified" option | |
543 | value passed on the git diff command line. | |
544 | ||
d81ed1b5 | 545 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
546 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
547 | program named by it is called, instead of the diff invocation | |
548 | described above. For a path that is added, removed, or modified, | |
549 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
550 | ||
551 | path old-file old-hex old-mode new-file new-hex new-mode | |
552 | + | |
553 | where: | |
554 | ||
555 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
556 | contents of <old|new>, | |
557 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, | |
558 | <old|new>-mode:: are the octal representation of the file modes. | |
559 | ||
560 | + | |
561 | The file parameters can point at the user's working file | |
562 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
563 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
564 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
565 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
566 | + | |
567 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
568 | parameter, <path>. | |
2cf565c5 | 569 | |
575ba9d6 ML |
570 | other |
571 | ~~~~~ | |
dbddb714 JN |
572 | 'GIT_MERGE_VERBOSITY':: |
573 | A number controlling the amount of output shown by | |
574 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 575 | See linkgit:git-merge[1] |
dbddb714 | 576 | |
c27d205a | 577 | 'GIT_PAGER':: |
a7738c77 SG |
578 | This environment variable overrides `$PAGER`. If it is set |
579 | to an empty string or to the value "cat", git will not launch | |
ab54cd6c JN |
580 | a pager. See also the `core.pager` option in |
581 | linkgit:git-config[1]. | |
c27d205a | 582 | |
d5538b41 | 583 | 'GIT_SSH':: |
0b444cdb TR |
584 | If this environment variable is set then 'git fetch' |
585 | and 'git push' will use this command instead | |
2fd02c92 | 586 | of 'ssh' when they need to connect to a remote system. |
483bc4f0 | 587 | The '$GIT_SSH' command will be given exactly two arguments: |
d5538b41 SP |
588 | the 'username@host' (or just 'host') from the URL and the |
589 | shell command to execute on that remote system. | |
590 | + | |
591 | To pass options to the program that you want to list in GIT_SSH | |
592 | you will need to wrap the program and options into a shell script, | |
593 | then set GIT_SSH to refer to the shell script. | |
594 | + | |
595 | Usually it is easier to configure any desired options through your | |
596 | personal `.ssh/config` file. Please consult your ssh documentation | |
597 | for further details. | |
598 | ||
06f59e9f TT |
599 | 'GIT_FLUSH':: |
600 | If this environment variable is set to "1", then commands such | |
0b444cdb TR |
601 | as 'git blame' (in incremental mode), 'git rev-list', 'git log', |
602 | and 'git whatchanged' will force a flush of the output stream | |
06f59e9f TT |
603 | after each commit-oriented record have been flushed. If this |
604 | variable is set to "0", the output of these commands will be done | |
605 | using completely buffered I/O. If this environment variable is | |
606 | not set, git will choose buffered or record-oriented flushing | |
607 | based on whether stdout appears to be redirected to a file or not. | |
608 | ||
575ba9d6 | 609 | 'GIT_TRACE':: |
2886bdb1 CC |
610 | If this variable is set to "1", "2" or "true" (comparison |
611 | is case insensitive), git will print `trace:` messages on | |
575ba9d6 ML |
612 | stderr telling about alias expansion, built-in command |
613 | execution and external command execution. | |
2886bdb1 CC |
614 | If this variable is set to an integer value greater than 1 |
615 | and lower than 10 (strictly) then git will interpret this | |
616 | value as an open file descriptor and will try to write the | |
617 | trace messages into this file descriptor. | |
618 | Alternatively, if this variable is set to an absolute path | |
619 | (starting with a '/' character), git will interpret this | |
620 | as a file path and will try to write the trace messages | |
621 | into it. | |
575ba9d6 | 622 | |
8db9307c JH |
623 | Discussion[[Discussion]] |
624 | ------------------------ | |
40dac517 BF |
625 | |
626 | More detail on the following is available from the | |
627 | link:user-manual.html#git-concepts[git concepts chapter of the | |
6998e4db | 628 | user-manual] and linkgit:gitcore-tutorial[7]. |
40dac517 BF |
629 | |
630 | A git project normally consists of a working directory with a ".git" | |
631 | subdirectory at the top level. The .git directory contains, among other | |
632 | things, a compressed object database representing the complete history | |
633 | of the project, an "index" file which links that history to the current | |
634 | contents of the working tree, and named pointers into that history such | |
635 | as tags and branch heads. | |
636 | ||
637 | The object database contains objects of three main types: blobs, which | |
638 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 639 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
640 | and some number of parent commits. |
641 | ||
642 | The commit, equivalent to what other systems call a "changeset" or | |
643 | "version", represents a step in the project's history, and each parent | |
644 | represents an immediately preceding step. Commits with more than one | |
645 | parent represent merges of independent lines of development. | |
646 | ||
647 | All objects are named by the SHA1 hash of their contents, normally | |
648 | written as a string of 40 hex digits. Such names are globally unique. | |
649 | The entire history leading up to a commit can be vouched for by signing | |
650 | just that commit. A fourth object type, the tag, is provided for this | |
651 | purpose. | |
652 | ||
653 | When first created, objects are stored in individual files, but for | |
654 | efficiency may later be compressed together into "pack files". | |
655 | ||
656 | Named pointers called refs mark interesting points in history. A ref | |
657 | may contain the SHA1 name of an object or the name of another ref. Refs | |
658 | with names beginning `ref/head/` contain the SHA1 name of the most | |
02ff6250 | 659 | recent commit (or "head") of a branch under development. SHA1 names of |
40dac517 BF |
660 | tags of interest are stored under `ref/tags/`. A special ref named |
661 | `HEAD` contains the name of the currently checked-out branch. | |
662 | ||
663 | The index file is initialized with a list of all paths and, for each | |
664 | path, a blob object and a set of attributes. The blob object represents | |
665 | the contents of the file as of the head of the current branch. The | |
666 | attributes (last modified time, size, etc.) are taken from the | |
667 | corresponding file in the working tree. Subsequent changes to the | |
668 | working tree can be found by comparing these attributes. The index may | |
669 | be updated with new content, and new commits may be created from the | |
670 | content stored in the index. | |
671 | ||
672 | The index is also capable of storing multiple entries (called "stages") | |
673 | for a given pathname. These stages are used to hold the various | |
674 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 675 | |
cb22bc44 AE |
676 | Authors |
677 | ------- | |
9755afbd | 678 | * git's founding father is Linus Torvalds <torvalds@osdl.org>. |
947ad2e1 | 679 | * The current git nurse is Junio C Hamano <gitster@pobox.com>. |
0240e21a | 680 | * The git potty was written by Andreas Ericsson <ae@op5.se>. |
9755afbd | 681 | * General upbringing is handled by the git-list <git@vger.kernel.org>. |
2cf565c5 DG |
682 | |
683 | Documentation | |
684 | -------------- | |
9755afbd JH |
685 | The documentation for git suite was started by David Greaves |
686 | <david@dgreaves.com>, and later enhanced greatly by the | |
687 | contributors on the git-list <git@vger.kernel.org>. | |
2cf565c5 | 688 | |
497c8331 CC |
689 | SEE ALSO |
690 | -------- | |
691 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
5cbef01a | 692 | link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7], |
497c8331 | 693 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
801a011d TR |
694 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], |
695 | linkgit:gitworkflows[7] | |
497c8331 | 696 | |
2cf565c5 DG |
697 | GIT |
698 | --- | |
9e1f0a85 | 699 | Part of the linkgit:git[1] suite |