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