submodule.c: factor out early loop termination in is_submodule_modified
[git.git] / Documentation / git.txt
blob3f75af872c040ade3bebdf8ae196e158f0688141
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
13     [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14     [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15     [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
16     [--super-prefix=<path>]
17     <command> [<args>]
19 DESCRIPTION
20 -----------
21 Git is a fast, scalable, distributed revision control system with an
22 unusually rich command set that provides both high-level operations
23 and full access to internals.
25 See linkgit:gittutorial[7] to get started, then see
26 linkgit:giteveryday[7] for a useful minimum set of
27 commands.  The link:user-manual.html[Git User's Manual] has a more
28 in-depth introduction.
30 After you mastered the basic concepts, you can come back to this
31 page to learn what commands Git offers.  You can learn more about
32 individual Git commands with "git help command".  linkgit:gitcli[7]
33 manual page gives you an overview of the command-line command syntax.
35 A formatted and hyperlinked copy of the latest Git documentation
36 can be viewed at `https://git.github.io/htmldocs/git.html`.
38 ifdef::stalenotes[]
39 [NOTE]
40 ============
42 You are reading the documentation for the latest (possibly
43 unreleased) version of Git, that is available from the 'master'
44 branch of the `git.git` repository.
45 Documentation for older releases are available here:
47 * link:v2.12.1/git.html[documentation for release 2.12.1]
49 * release notes for
50   link:RelNotes/2.12.1.txt[2.12.1].
51   link:RelNotes/2.12.0.txt[2.12].
53 * link:v2.11.1/git.html[documentation for release 2.11.1]
55 * release notes for
56   link:RelNotes/2.11.1.txt[2.11.1],
57   link:RelNotes/2.11.0.txt[2.11].
59 * link:v2.10.2/git.html[documentation for release 2.10.2]
61 * release notes for
62   link:RelNotes/2.10.2.txt[2.10.2],
63   link:RelNotes/2.10.1.txt[2.10.1],
64   link:RelNotes/2.10.0.txt[2.10].
66 * link:v2.9.3/git.html[documentation for release 2.9.3]
68 * release notes for
69   link:RelNotes/2.9.3.txt[2.9.3],
70   link:RelNotes/2.9.2.txt[2.9.2],
71   link:RelNotes/2.9.1.txt[2.9.1],
72   link:RelNotes/2.9.0.txt[2.9].
74 * link:v2.8.4/git.html[documentation for release 2.8.4]
76 * release notes for
77   link:RelNotes/2.8.4.txt[2.8.4],
78   link:RelNotes/2.8.3.txt[2.8.3],
79   link:RelNotes/2.8.2.txt[2.8.2],
80   link:RelNotes/2.8.1.txt[2.8.1],
81   link:RelNotes/2.8.0.txt[2.8].
83 * link:v2.7.3/git.html[documentation for release 2.7.3]
85 * release notes for
86   link:RelNotes/2.7.3.txt[2.7.3],
87   link:RelNotes/2.7.2.txt[2.7.2],
88   link:RelNotes/2.7.1.txt[2.7.1],
89   link:RelNotes/2.7.0.txt[2.7].
91 * link:v2.6.6/git.html[documentation for release 2.6.6]
93 * release notes for
94   link:RelNotes/2.6.6.txt[2.6.6],
95   link:RelNotes/2.6.5.txt[2.6.5],
96   link:RelNotes/2.6.4.txt[2.6.4],
97   link:RelNotes/2.6.3.txt[2.6.3],
98   link:RelNotes/2.6.2.txt[2.6.2],
99   link:RelNotes/2.6.1.txt[2.6.1],
100   link:RelNotes/2.6.0.txt[2.6].
102 * link:v2.5.5/git.html[documentation for release 2.5.5]
104 * release notes for
105   link:RelNotes/2.5.5.txt[2.5.5],
106   link:RelNotes/2.5.4.txt[2.5.4],
107   link:RelNotes/2.5.3.txt[2.5.3],
108   link:RelNotes/2.5.2.txt[2.5.2],
109   link:RelNotes/2.5.1.txt[2.5.1],
110   link:RelNotes/2.5.0.txt[2.5].
112 * link:v2.4.11/git.html[documentation for release 2.4.11]
114 * release notes for
115   link:RelNotes/2.4.11.txt[2.4.11],
116   link:RelNotes/2.4.10.txt[2.4.10],
117   link:RelNotes/2.4.9.txt[2.4.9],
118   link:RelNotes/2.4.8.txt[2.4.8],
119   link:RelNotes/2.4.7.txt[2.4.7],
120   link:RelNotes/2.4.6.txt[2.4.6],
121   link:RelNotes/2.4.5.txt[2.4.5],
122   link:RelNotes/2.4.4.txt[2.4.4],
123   link:RelNotes/2.4.3.txt[2.4.3],
124   link:RelNotes/2.4.2.txt[2.4.2],
125   link:RelNotes/2.4.1.txt[2.4.1],
126   link:RelNotes/2.4.0.txt[2.4].
128 * link:v2.3.10/git.html[documentation for release 2.3.10]
130 * release notes for
131   link:RelNotes/2.3.10.txt[2.3.10],
132   link:RelNotes/2.3.9.txt[2.3.9],
133   link:RelNotes/2.3.8.txt[2.3.8],
134   link:RelNotes/2.3.7.txt[2.3.7],
135   link:RelNotes/2.3.6.txt[2.3.6],
136   link:RelNotes/2.3.5.txt[2.3.5],
137   link:RelNotes/2.3.4.txt[2.3.4],
138   link:RelNotes/2.3.3.txt[2.3.3],
139   link:RelNotes/2.3.2.txt[2.3.2],
140   link:RelNotes/2.3.1.txt[2.3.1],
141   link:RelNotes/2.3.0.txt[2.3].
143 * link:v2.2.3/git.html[documentation for release 2.2.3]
145 * release notes for
146   link:RelNotes/2.2.3.txt[2.2.3],
147   link:RelNotes/2.2.2.txt[2.2.2],
148   link:RelNotes/2.2.1.txt[2.2.1],
149   link:RelNotes/2.2.0.txt[2.2].
151 * link:v2.1.4/git.html[documentation for release 2.1.4]
153 * release notes for
154   link:RelNotes/2.1.4.txt[2.1.4],
155   link:RelNotes/2.1.3.txt[2.1.3],
156   link:RelNotes/2.1.2.txt[2.1.2],
157   link:RelNotes/2.1.1.txt[2.1.1],
158   link:RelNotes/2.1.0.txt[2.1].
160 * link:v2.0.5/git.html[documentation for release 2.0.5]
162 * release notes for
163   link:RelNotes/2.0.5.txt[2.0.5],
164   link:RelNotes/2.0.4.txt[2.0.4],
165   link:RelNotes/2.0.3.txt[2.0.3],
166   link:RelNotes/2.0.2.txt[2.0.2],
167   link:RelNotes/2.0.1.txt[2.0.1],
168   link:RelNotes/2.0.0.txt[2.0.0].
170 * link:v1.9.5/git.html[documentation for release 1.9.5]
172 * release notes for
173   link:RelNotes/1.9.5.txt[1.9.5],
174   link:RelNotes/1.9.4.txt[1.9.4],
175   link:RelNotes/1.9.3.txt[1.9.3],
176   link:RelNotes/1.9.2.txt[1.9.2],
177   link:RelNotes/1.9.1.txt[1.9.1],
178   link:RelNotes/1.9.0.txt[1.9.0].
180 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
182 * release notes for
183   link:RelNotes/1.8.5.6.txt[1.8.5.6],
184   link:RelNotes/1.8.5.5.txt[1.8.5.5],
185   link:RelNotes/1.8.5.4.txt[1.8.5.4],
186   link:RelNotes/1.8.5.3.txt[1.8.5.3],
187   link:RelNotes/1.8.5.2.txt[1.8.5.2],
188   link:RelNotes/1.8.5.1.txt[1.8.5.1],
189   link:RelNotes/1.8.5.txt[1.8.5].
191 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
193 * release notes for
194   link:RelNotes/1.8.4.5.txt[1.8.4.5],
195   link:RelNotes/1.8.4.4.txt[1.8.4.4],
196   link:RelNotes/1.8.4.3.txt[1.8.4.3],
197   link:RelNotes/1.8.4.2.txt[1.8.4.2],
198   link:RelNotes/1.8.4.1.txt[1.8.4.1],
199   link:RelNotes/1.8.4.txt[1.8.4].
201 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
203 * release notes for
204   link:RelNotes/1.8.3.4.txt[1.8.3.4],
205   link:RelNotes/1.8.3.3.txt[1.8.3.3],
206   link:RelNotes/1.8.3.2.txt[1.8.3.2],
207   link:RelNotes/1.8.3.1.txt[1.8.3.1],
208   link:RelNotes/1.8.3.txt[1.8.3].
210 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
212 * release notes for
213   link:RelNotes/1.8.2.3.txt[1.8.2.3],
214   link:RelNotes/1.8.2.2.txt[1.8.2.2],
215   link:RelNotes/1.8.2.1.txt[1.8.2.1],
216   link:RelNotes/1.8.2.txt[1.8.2].
218 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
220 * release notes for
221   link:RelNotes/1.8.1.6.txt[1.8.1.6],
222   link:RelNotes/1.8.1.5.txt[1.8.1.5],
223   link:RelNotes/1.8.1.4.txt[1.8.1.4],
224   link:RelNotes/1.8.1.3.txt[1.8.1.3],
225   link:RelNotes/1.8.1.2.txt[1.8.1.2],
226   link:RelNotes/1.8.1.1.txt[1.8.1.1],
227   link:RelNotes/1.8.1.txt[1.8.1].
229 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
231 * release notes for
232   link:RelNotes/1.8.0.3.txt[1.8.0.3],
233   link:RelNotes/1.8.0.2.txt[1.8.0.2],
234   link:RelNotes/1.8.0.1.txt[1.8.0.1],
235   link:RelNotes/1.8.0.txt[1.8.0].
237 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
239 * release notes for
240   link:RelNotes/1.7.12.4.txt[1.7.12.4],
241   link:RelNotes/1.7.12.3.txt[1.7.12.3],
242   link:RelNotes/1.7.12.2.txt[1.7.12.2],
243   link:RelNotes/1.7.12.1.txt[1.7.12.1],
244   link:RelNotes/1.7.12.txt[1.7.12].
246 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
248 * release notes for
249   link:RelNotes/1.7.11.7.txt[1.7.11.7],
250   link:RelNotes/1.7.11.6.txt[1.7.11.6],
251   link:RelNotes/1.7.11.5.txt[1.7.11.5],
252   link:RelNotes/1.7.11.4.txt[1.7.11.4],
253   link:RelNotes/1.7.11.3.txt[1.7.11.3],
254   link:RelNotes/1.7.11.2.txt[1.7.11.2],
255   link:RelNotes/1.7.11.1.txt[1.7.11.1],
256   link:RelNotes/1.7.11.txt[1.7.11].
258 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
260 * release notes for
261   link:RelNotes/1.7.10.5.txt[1.7.10.5],
262   link:RelNotes/1.7.10.4.txt[1.7.10.4],
263   link:RelNotes/1.7.10.3.txt[1.7.10.3],
264   link:RelNotes/1.7.10.2.txt[1.7.10.2],
265   link:RelNotes/1.7.10.1.txt[1.7.10.1],
266   link:RelNotes/1.7.10.txt[1.7.10].
268 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
270 * release notes for
271   link:RelNotes/1.7.9.7.txt[1.7.9.7],
272   link:RelNotes/1.7.9.6.txt[1.7.9.6],
273   link:RelNotes/1.7.9.5.txt[1.7.9.5],
274   link:RelNotes/1.7.9.4.txt[1.7.9.4],
275   link:RelNotes/1.7.9.3.txt[1.7.9.3],
276   link:RelNotes/1.7.9.2.txt[1.7.9.2],
277   link:RelNotes/1.7.9.1.txt[1.7.9.1],
278   link:RelNotes/1.7.9.txt[1.7.9].
280 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
282 * release notes for
283   link:RelNotes/1.7.8.6.txt[1.7.8.6],
284   link:RelNotes/1.7.8.5.txt[1.7.8.5],
285   link:RelNotes/1.7.8.4.txt[1.7.8.4],
286   link:RelNotes/1.7.8.3.txt[1.7.8.3],
287   link:RelNotes/1.7.8.2.txt[1.7.8.2],
288   link:RelNotes/1.7.8.1.txt[1.7.8.1],
289   link:RelNotes/1.7.8.txt[1.7.8].
291 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
293 * release notes for
294   link:RelNotes/1.7.7.7.txt[1.7.7.7],
295   link:RelNotes/1.7.7.6.txt[1.7.7.6],
296   link:RelNotes/1.7.7.5.txt[1.7.7.5],
297   link:RelNotes/1.7.7.4.txt[1.7.7.4],
298   link:RelNotes/1.7.7.3.txt[1.7.7.3],
299   link:RelNotes/1.7.7.2.txt[1.7.7.2],
300   link:RelNotes/1.7.7.1.txt[1.7.7.1],
301   link:RelNotes/1.7.7.txt[1.7.7].
303 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
305 * release notes for
306   link:RelNotes/1.7.6.6.txt[1.7.6.6],
307   link:RelNotes/1.7.6.5.txt[1.7.6.5],
308   link:RelNotes/1.7.6.4.txt[1.7.6.4],
309   link:RelNotes/1.7.6.3.txt[1.7.6.3],
310   link:RelNotes/1.7.6.2.txt[1.7.6.2],
311   link:RelNotes/1.7.6.1.txt[1.7.6.1],
312   link:RelNotes/1.7.6.txt[1.7.6].
314 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
316 * release notes for
317   link:RelNotes/1.7.5.4.txt[1.7.5.4],
318   link:RelNotes/1.7.5.3.txt[1.7.5.3],
319   link:RelNotes/1.7.5.2.txt[1.7.5.2],
320   link:RelNotes/1.7.5.1.txt[1.7.5.1],
321   link:RelNotes/1.7.5.txt[1.7.5].
323 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
325 * release notes for
326   link:RelNotes/1.7.4.5.txt[1.7.4.5],
327   link:RelNotes/1.7.4.4.txt[1.7.4.4],
328   link:RelNotes/1.7.4.3.txt[1.7.4.3],
329   link:RelNotes/1.7.4.2.txt[1.7.4.2],
330   link:RelNotes/1.7.4.1.txt[1.7.4.1],
331   link:RelNotes/1.7.4.txt[1.7.4].
333 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
335 * release notes for
336   link:RelNotes/1.7.3.5.txt[1.7.3.5],
337   link:RelNotes/1.7.3.4.txt[1.7.3.4],
338   link:RelNotes/1.7.3.3.txt[1.7.3.3],
339   link:RelNotes/1.7.3.2.txt[1.7.3.2],
340   link:RelNotes/1.7.3.1.txt[1.7.3.1],
341   link:RelNotes/1.7.3.txt[1.7.3].
343 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
345 * release notes for
346   link:RelNotes/1.7.2.5.txt[1.7.2.5],
347   link:RelNotes/1.7.2.4.txt[1.7.2.4],
348   link:RelNotes/1.7.2.3.txt[1.7.2.3],
349   link:RelNotes/1.7.2.2.txt[1.7.2.2],
350   link:RelNotes/1.7.2.1.txt[1.7.2.1],
351   link:RelNotes/1.7.2.txt[1.7.2].
353 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
355 * release notes for
356   link:RelNotes/1.7.1.4.txt[1.7.1.4],
357   link:RelNotes/1.7.1.3.txt[1.7.1.3],
358   link:RelNotes/1.7.1.2.txt[1.7.1.2],
359   link:RelNotes/1.7.1.1.txt[1.7.1.1],
360   link:RelNotes/1.7.1.txt[1.7.1].
362 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
364 * release notes for
365   link:RelNotes/1.7.0.9.txt[1.7.0.9],
366   link:RelNotes/1.7.0.8.txt[1.7.0.8],
367   link:RelNotes/1.7.0.7.txt[1.7.0.7],
368   link:RelNotes/1.7.0.6.txt[1.7.0.6],
369   link:RelNotes/1.7.0.5.txt[1.7.0.5],
370   link:RelNotes/1.7.0.4.txt[1.7.0.4],
371   link:RelNotes/1.7.0.3.txt[1.7.0.3],
372   link:RelNotes/1.7.0.2.txt[1.7.0.2],
373   link:RelNotes/1.7.0.1.txt[1.7.0.1],
374   link:RelNotes/1.7.0.txt[1.7.0].
376 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
378 * release notes for
379   link:RelNotes/1.6.6.3.txt[1.6.6.3],
380   link:RelNotes/1.6.6.2.txt[1.6.6.2],
381   link:RelNotes/1.6.6.1.txt[1.6.6.1],
382   link:RelNotes/1.6.6.txt[1.6.6].
384 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
386 * release notes for
387   link:RelNotes/1.6.5.9.txt[1.6.5.9],
388   link:RelNotes/1.6.5.8.txt[1.6.5.8],
389   link:RelNotes/1.6.5.7.txt[1.6.5.7],
390   link:RelNotes/1.6.5.6.txt[1.6.5.6],
391   link:RelNotes/1.6.5.5.txt[1.6.5.5],
392   link:RelNotes/1.6.5.4.txt[1.6.5.4],
393   link:RelNotes/1.6.5.3.txt[1.6.5.3],
394   link:RelNotes/1.6.5.2.txt[1.6.5.2],
395   link:RelNotes/1.6.5.1.txt[1.6.5.1],
396   link:RelNotes/1.6.5.txt[1.6.5].
398 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
400 * release notes for
401   link:RelNotes/1.6.4.5.txt[1.6.4.5],
402   link:RelNotes/1.6.4.4.txt[1.6.4.4],
403   link:RelNotes/1.6.4.3.txt[1.6.4.3],
404   link:RelNotes/1.6.4.2.txt[1.6.4.2],
405   link:RelNotes/1.6.4.1.txt[1.6.4.1],
406   link:RelNotes/1.6.4.txt[1.6.4].
408 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
410 * release notes for
411   link:RelNotes/1.6.3.4.txt[1.6.3.4],
412   link:RelNotes/1.6.3.3.txt[1.6.3.3],
413   link:RelNotes/1.6.3.2.txt[1.6.3.2],
414   link:RelNotes/1.6.3.1.txt[1.6.3.1],
415   link:RelNotes/1.6.3.txt[1.6.3].
417 * release notes for
418   link:RelNotes/1.6.2.5.txt[1.6.2.5],
419   link:RelNotes/1.6.2.4.txt[1.6.2.4],
420   link:RelNotes/1.6.2.3.txt[1.6.2.3],
421   link:RelNotes/1.6.2.2.txt[1.6.2.2],
422   link:RelNotes/1.6.2.1.txt[1.6.2.1],
423   link:RelNotes/1.6.2.txt[1.6.2].
425 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
427 * release notes for
428   link:RelNotes/1.6.1.3.txt[1.6.1.3],
429   link:RelNotes/1.6.1.2.txt[1.6.1.2],
430   link:RelNotes/1.6.1.1.txt[1.6.1.1],
431   link:RelNotes/1.6.1.txt[1.6.1].
433 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
435 * release notes for
436   link:RelNotes/1.6.0.6.txt[1.6.0.6],
437   link:RelNotes/1.6.0.5.txt[1.6.0.5],
438   link:RelNotes/1.6.0.4.txt[1.6.0.4],
439   link:RelNotes/1.6.0.3.txt[1.6.0.3],
440   link:RelNotes/1.6.0.2.txt[1.6.0.2],
441   link:RelNotes/1.6.0.1.txt[1.6.0.1],
442   link:RelNotes/1.6.0.txt[1.6.0].
444 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
446 * release notes for
447   link:RelNotes/1.5.6.6.txt[1.5.6.6],
448   link:RelNotes/1.5.6.5.txt[1.5.6.5],
449   link:RelNotes/1.5.6.4.txt[1.5.6.4],
450   link:RelNotes/1.5.6.3.txt[1.5.6.3],
451   link:RelNotes/1.5.6.2.txt[1.5.6.2],
452   link:RelNotes/1.5.6.1.txt[1.5.6.1],
453   link:RelNotes/1.5.6.txt[1.5.6].
455 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
457 * release notes for
458   link:RelNotes/1.5.5.6.txt[1.5.5.6],
459   link:RelNotes/1.5.5.5.txt[1.5.5.5],
460   link:RelNotes/1.5.5.4.txt[1.5.5.4],
461   link:RelNotes/1.5.5.3.txt[1.5.5.3],
462   link:RelNotes/1.5.5.2.txt[1.5.5.2],
463   link:RelNotes/1.5.5.1.txt[1.5.5.1],
464   link:RelNotes/1.5.5.txt[1.5.5].
466 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
468 * release notes for
469   link:RelNotes/1.5.4.7.txt[1.5.4.7],
470   link:RelNotes/1.5.4.6.txt[1.5.4.6],
471   link:RelNotes/1.5.4.5.txt[1.5.4.5],
472   link:RelNotes/1.5.4.4.txt[1.5.4.4],
473   link:RelNotes/1.5.4.3.txt[1.5.4.3],
474   link:RelNotes/1.5.4.2.txt[1.5.4.2],
475   link:RelNotes/1.5.4.1.txt[1.5.4.1],
476   link:RelNotes/1.5.4.txt[1.5.4].
478 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
480 * release notes for
481   link:RelNotes/1.5.3.8.txt[1.5.3.8],
482   link:RelNotes/1.5.3.7.txt[1.5.3.7],
483   link:RelNotes/1.5.3.6.txt[1.5.3.6],
484   link:RelNotes/1.5.3.5.txt[1.5.3.5],
485   link:RelNotes/1.5.3.4.txt[1.5.3.4],
486   link:RelNotes/1.5.3.3.txt[1.5.3.3],
487   link:RelNotes/1.5.3.2.txt[1.5.3.2],
488   link:RelNotes/1.5.3.1.txt[1.5.3.1],
489   link:RelNotes/1.5.3.txt[1.5.3].
491 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
493 * release notes for
494   link:RelNotes/1.5.2.5.txt[1.5.2.5],
495   link:RelNotes/1.5.2.4.txt[1.5.2.4],
496   link:RelNotes/1.5.2.3.txt[1.5.2.3],
497   link:RelNotes/1.5.2.2.txt[1.5.2.2],
498   link:RelNotes/1.5.2.1.txt[1.5.2.1],
499   link:RelNotes/1.5.2.txt[1.5.2].
501 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
503 * release notes for
504   link:RelNotes/1.5.1.6.txt[1.5.1.6],
505   link:RelNotes/1.5.1.5.txt[1.5.1.5],
506   link:RelNotes/1.5.1.4.txt[1.5.1.4],
507   link:RelNotes/1.5.1.3.txt[1.5.1.3],
508   link:RelNotes/1.5.1.2.txt[1.5.1.2],
509   link:RelNotes/1.5.1.1.txt[1.5.1.1],
510   link:RelNotes/1.5.1.txt[1.5.1].
512 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
514 * release notes for
515   link:RelNotes/1.5.0.7.txt[1.5.0.7],
516   link:RelNotes/1.5.0.6.txt[1.5.0.6],
517   link:RelNotes/1.5.0.5.txt[1.5.0.5],
518   link:RelNotes/1.5.0.3.txt[1.5.0.3],
519   link:RelNotes/1.5.0.2.txt[1.5.0.2],
520   link:RelNotes/1.5.0.1.txt[1.5.0.1],
521   link:RelNotes/1.5.0.txt[1.5.0].
523 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
524   link:v1.3.3/git.html[1.3.3],
525   link:v1.2.6/git.html[1.2.6],
526   link:v1.0.13/git.html[1.0.13].
528 ============
530 endif::stalenotes[]
532 OPTIONS
533 -------
534 --version::
535         Prints the Git suite version that the 'git' program came from.
537 --help::
538         Prints the synopsis and a list of the most commonly used
539         commands. If the option `--all` or `-a` is given then all
540         available commands are printed. If a Git command is named this
541         option will bring up the manual page for that command.
543 Other options are available to control how the manual page is
544 displayed. See linkgit:git-help[1] for more information,
545 because `git --help ...` is converted internally into `git
546 help ...`.
548 -C <path>::
549         Run as if git was started in '<path>' instead of the current working
550         directory.  When multiple `-C` options are given, each subsequent
551         non-absolute `-C <path>` is interpreted relative to the preceding `-C
552         <path>`.
554 This option affects options that expect path name like `--git-dir` and
555 `--work-tree` in that their interpretations of the path names would be
556 made relative to the working directory caused by the `-C` option. For
557 example the following invocations are equivalent:
559     git --git-dir=a.git --work-tree=b -C c status
560     git --git-dir=c/a.git --work-tree=c/b status
562 -c <name>=<value>::
563         Pass a configuration parameter to the command. The value
564         given will override values from configuration files.
565         The <name> is expected in the same format as listed by
566         'git config' (subkeys separated by dots).
568 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
569 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
570 config file). Including the equals but with an empty value (like `git -c
571 foo.bar= ...`) sets `foo.bar` to the empty string.
573 --exec-path[=<path>]::
574         Path to wherever your core Git programs are installed.
575         This can also be controlled by setting the GIT_EXEC_PATH
576         environment variable. If no path is given, 'git' will print
577         the current setting and then exit.
579 --html-path::
580         Print the path, without trailing slash, where Git's HTML
581         documentation is installed and exit.
583 --man-path::
584         Print the manpath (see `man(1)`) for the man pages for
585         this version of Git and exit.
587 --info-path::
588         Print the path where the Info files documenting this
589         version of Git are installed and exit.
591 -p::
592 --paginate::
593         Pipe all output into 'less' (or if set, $PAGER) if standard
594         output is a terminal.  This overrides the `pager.<cmd>`
595         configuration options (see the "Configuration Mechanism" section
596         below).
598 --no-pager::
599         Do not pipe Git output into a pager.
601 --git-dir=<path>::
602         Set the path to the repository. This can also be controlled by
603         setting the `GIT_DIR` environment variable. It can be an absolute
604         path or relative path to current working directory.
606 --work-tree=<path>::
607         Set the path to the working tree. It can be an absolute path
608         or a path relative to the current working directory.
609         This can also be controlled by setting the GIT_WORK_TREE
610         environment variable and the core.worktree configuration
611         variable (see core.worktree in linkgit:git-config[1] for a
612         more detailed discussion).
614 --namespace=<path>::
615         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
616         details.  Equivalent to setting the `GIT_NAMESPACE` environment
617         variable.
619 --super-prefix=<path>::
620         Currently for internal use only.  Set a prefix which gives a path from
621         above a repository down to its root.  One use is to give submodules
622         context about the superproject that invoked it.
624 --bare::
625         Treat the repository as a bare repository.  If GIT_DIR
626         environment is not set, it is set to the current working
627         directory.
629 --no-replace-objects::
630         Do not use replacement refs to replace Git objects. See
631         linkgit:git-replace[1] for more information.
633 --literal-pathspecs::
634         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
635         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
636         variable to `1`.
638 --glob-pathspecs::
639         Add "glob" magic to all pathspec. This is equivalent to setting
640         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
641         globbing on individual pathspecs can be done using pathspec
642         magic ":(literal)"
644 --noglob-pathspecs::
645         Add "literal" magic to all pathspec. This is equivalent to setting
646         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
647         globbing on individual pathspecs can be done using pathspec
648         magic ":(glob)"
650 --icase-pathspecs::
651         Add "icase" magic to all pathspec. This is equivalent to setting
652         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
654 GIT COMMANDS
655 ------------
657 We divide Git into high level ("porcelain") commands and low level
658 ("plumbing") commands.
660 High-level commands (porcelain)
661 -------------------------------
663 We separate the porcelain commands into the main commands and some
664 ancillary user utilities.
666 Main porcelain commands
667 ~~~~~~~~~~~~~~~~~~~~~~~
669 include::cmds-mainporcelain.txt[]
671 Ancillary Commands
672 ~~~~~~~~~~~~~~~~~~
673 Manipulators:
675 include::cmds-ancillarymanipulators.txt[]
677 Interrogators:
679 include::cmds-ancillaryinterrogators.txt[]
682 Interacting with Others
683 ~~~~~~~~~~~~~~~~~~~~~~~
685 These commands are to interact with foreign SCM and with other
686 people via patch over e-mail.
688 include::cmds-foreignscminterface.txt[]
691 Low-level commands (plumbing)
692 -----------------------------
694 Although Git includes its
695 own porcelain layer, its low-level commands are sufficient to support
696 development of alternative porcelains.  Developers of such porcelains
697 might start by reading about linkgit:git-update-index[1] and
698 linkgit:git-read-tree[1].
700 The interface (input, output, set of options and the semantics)
701 to these low-level commands are meant to be a lot more stable
702 than Porcelain level commands, because these commands are
703 primarily for scripted use.  The interface to Porcelain commands
704 on the other hand are subject to change in order to improve the
705 end user experience.
707 The following description divides
708 the low-level commands into commands that manipulate objects (in
709 the repository, index, and working tree), commands that interrogate and
710 compare objects, and commands that move objects and references between
711 repositories.
714 Manipulation commands
715 ~~~~~~~~~~~~~~~~~~~~~
717 include::cmds-plumbingmanipulators.txt[]
720 Interrogation commands
721 ~~~~~~~~~~~~~~~~~~~~~~
723 include::cmds-plumbinginterrogators.txt[]
725 In general, the interrogate commands do not touch the files in
726 the working tree.
729 Synching repositories
730 ~~~~~~~~~~~~~~~~~~~~~
732 include::cmds-synchingrepositories.txt[]
734 The following are helper commands used by the above; end users
735 typically do not use them directly.
737 include::cmds-synchelpers.txt[]
740 Internal helper commands
741 ~~~~~~~~~~~~~~~~~~~~~~~~
743 These are internal helper commands used by other commands; end
744 users typically do not use them directly.
746 include::cmds-purehelpers.txt[]
749 Configuration Mechanism
750 -----------------------
752 Git uses a simple text format to store customizations that are per
753 repository and are per user.  Such a configuration file may look
754 like this:
756 ------------
758 # A '#' or ';' character indicates a comment.
761 ; core variables
762 [core]
763         ; Don't trust file modes
764         filemode = false
766 ; user identity
767 [user]
768         name = "Junio C Hamano"
769         email = "gitster@pobox.com"
771 ------------
773 Various commands read from the configuration file and adjust
774 their operation accordingly.  See linkgit:git-config[1] for a
775 list and more details about the configuration mechanism.
778 Identifier Terminology
779 ----------------------
780 <object>::
781         Indicates the object name for any type of object.
783 <blob>::
784         Indicates a blob object name.
786 <tree>::
787         Indicates a tree object name.
789 <commit>::
790         Indicates a commit object name.
792 <tree-ish>::
793         Indicates a tree, commit or tag object name.  A
794         command that takes a <tree-ish> argument ultimately wants to
795         operate on a <tree> object but automatically dereferences
796         <commit> and <tag> objects that point at a <tree>.
798 <commit-ish>::
799         Indicates a commit or tag object name.  A
800         command that takes a <commit-ish> argument ultimately wants to
801         operate on a <commit> object but automatically dereferences
802         <tag> objects that point at a <commit>.
804 <type>::
805         Indicates that an object type is required.
806         Currently one of: `blob`, `tree`, `commit`, or `tag`.
808 <file>::
809         Indicates a filename - almost always relative to the
810         root of the tree structure `GIT_INDEX_FILE` describes.
812 Symbolic Identifiers
813 --------------------
814 Any Git command accepting any <object> can also use the following
815 symbolic notation:
817 HEAD::
818         indicates the head of the current branch.
820 <tag>::
821         a valid tag 'name'
822         (i.e. a `refs/tags/<tag>` reference).
824 <head>::
825         a valid head 'name'
826         (i.e. a `refs/heads/<head>` reference).
828 For a more complete list of ways to spell object names, see
829 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
832 File/Directory Structure
833 ------------------------
835 Please see the linkgit:gitrepository-layout[5] document.
837 Read linkgit:githooks[5] for more details about each hook.
839 Higher level SCMs may provide and manage additional information in the
840 `$GIT_DIR`.
843 Terminology
844 -----------
845 Please see linkgit:gitglossary[7].
848 Environment Variables
849 ---------------------
850 Various Git commands use the following environment variables:
852 The Git Repository
853 ~~~~~~~~~~~~~~~~~~
854 These environment variables apply to 'all' core Git commands. Nb: it
855 is worth noting that they may be used/overridden by SCMS sitting above
856 Git so take care if using a foreign front-end.
858 `GIT_INDEX_FILE`::
859         This environment allows the specification of an alternate
860         index file. If not specified, the default of `$GIT_DIR/index`
861         is used.
863 `GIT_INDEX_VERSION`::
864         This environment variable allows the specification of an index
865         version for new repositories.  It won't affect existing index
866         files.  By default index file version 2 or 3 is used. See
867         linkgit:git-update-index[1] for more information.
869 `GIT_OBJECT_DIRECTORY`::
870         If the object storage directory is specified via this
871         environment variable then the sha1 directories are created
872         underneath - otherwise the default `$GIT_DIR/objects`
873         directory is used.
875 `GIT_ALTERNATE_OBJECT_DIRECTORIES`::
876         Due to the immutable nature of Git objects, old objects can be
877         archived into shared, read-only directories. This variable
878         specifies a ":" separated (on Windows ";" separated) list
879         of Git object directories which can be used to search for Git
880         objects. New objects will not be written to these directories.
882         Entries that begin with `"` (double-quote) will be interpreted
883         as C-style quoted paths, removing leading and trailing
884         double-quotes and respecting backslash escapes. E.g., the value
885         `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
886         `path-with-"-and-:-in-it` and `vanilla-path`.
888 `GIT_DIR`::
889         If the `GIT_DIR` environment variable is set then it
890         specifies a path to use instead of the default `.git`
891         for the base of the repository.
892         The `--git-dir` command-line option also sets this value.
894 `GIT_WORK_TREE`::
895         Set the path to the root of the working tree.
896         This can also be controlled by the `--work-tree` command-line
897         option and the core.worktree configuration variable.
899 `GIT_NAMESPACE`::
900         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
901         The `--namespace` command-line option also sets this value.
903 `GIT_CEILING_DIRECTORIES`::
904         This should be a colon-separated list of absolute paths.  If
905         set, it is a list of directories that Git should not chdir up
906         into while looking for a repository directory (useful for
907         excluding slow-loading network directories).  It will not
908         exclude the current working directory or a GIT_DIR set on the
909         command line or in the environment.  Normally, Git has to read
910         the entries in this list and resolve any symlink that
911         might be present in order to compare them with the current
912         directory.  However, if even this access is slow, you
913         can add an empty entry to the list to tell Git that the
914         subsequent entries are not symlinks and needn't be resolved;
915         e.g.,
916         `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
918 `GIT_DISCOVERY_ACROSS_FILESYSTEM`::
919         When run in a directory that does not have ".git" repository
920         directory, Git tries to find such a directory in the parent
921         directories to find the top of the working tree, but by default it
922         does not cross filesystem boundaries.  This environment variable
923         can be set to true to tell Git not to stop at filesystem
924         boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
925         an explicit repository directory set via `GIT_DIR` or on the
926         command line.
928 `GIT_COMMON_DIR`::
929         If this variable is set to a path, non-worktree files that are
930         normally in $GIT_DIR will be taken from this path
931         instead. Worktree-specific files such as HEAD or index are
932         taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
933         linkgit:git-worktree[1] for
934         details. This variable has lower precedence than other path
935         variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
937 Git Commits
938 ~~~~~~~~~~~
939 `GIT_AUTHOR_NAME`::
940 `GIT_AUTHOR_EMAIL`::
941 `GIT_AUTHOR_DATE`::
942 `GIT_COMMITTER_NAME`::
943 `GIT_COMMITTER_EMAIL`::
944 `GIT_COMMITTER_DATE`::
945 'EMAIL'::
946         see linkgit:git-commit-tree[1]
948 Git Diffs
949 ~~~~~~~~~
950 `GIT_DIFF_OPTS`::
951         Only valid setting is "--unified=??" or "-u??" to set the
952         number of context lines shown when a unified diff is created.
953         This takes precedence over any "-U" or "--unified" option
954         value passed on the Git diff command line.
956 `GIT_EXTERNAL_DIFF`::
957         When the environment variable `GIT_EXTERNAL_DIFF` is set, the
958         program named by it is called, instead of the diff invocation
959         described above.  For a path that is added, removed, or modified,
960         `GIT_EXTERNAL_DIFF` is called with 7 parameters:
962         path old-file old-hex old-mode new-file new-hex new-mode
964 where:
966         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
967                          contents of <old|new>,
968         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
969         <old|new>-mode:: are the octal representation of the file modes.
971 The file parameters can point at the user's working file
972 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
973 when a new file is added), or a temporary file (e.g. `old-file` in the
974 index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
975 temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
977 For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
978 parameter, <path>.
980 For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
981 `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
983 `GIT_DIFF_PATH_COUNTER`::
984         A 1-based counter incremented by one for every path.
986 `GIT_DIFF_PATH_TOTAL`::
987         The total number of paths.
989 other
990 ~~~~~
991 `GIT_MERGE_VERBOSITY`::
992         A number controlling the amount of output shown by
993         the recursive merge strategy.  Overrides merge.verbosity.
994         See linkgit:git-merge[1]
996 `GIT_PAGER`::
997         This environment variable overrides `$PAGER`. If it is set
998         to an empty string or to the value "cat", Git will not launch
999         a pager.  See also the `core.pager` option in
1000         linkgit:git-config[1].
1002 `GIT_EDITOR`::
1003         This environment variable overrides `$EDITOR` and `$VISUAL`.
1004         It is used by several Git commands when, on interactive mode,
1005         an editor is to be launched. See also linkgit:git-var[1]
1006         and the `core.editor` option in linkgit:git-config[1].
1008 `GIT_SSH`::
1009 `GIT_SSH_COMMAND`::
1010         If either of these environment variables is set then 'git fetch'
1011         and 'git push' will use the specified command instead of 'ssh'
1012         when they need to connect to a remote system.
1013         The command will be given exactly two or four arguments: the
1014         'username@host' (or just 'host') from the URL and the shell
1015         command to execute on that remote system, optionally preceded by
1016         `-p` (literally) and the 'port' from the URL when it specifies
1017         something other than the default SSH port.
1019 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
1020 by the shell, which allows additional arguments to be included.
1021 `$GIT_SSH` on the other hand must be just the path to a program
1022 (which can be a wrapper shell script, if additional arguments are
1023 needed).
1025 Usually it is easier to configure any desired options through your
1026 personal `.ssh/config` file.  Please consult your ssh documentation
1027 for further details.
1029 `GIT_SSH_VARIANT`::
1030         If this environment variable is set, it overrides Git's autodetection
1031         whether `GIT_SSH`/`GIT_SSH_COMMAND`/`core.sshCommand` refer to OpenSSH,
1032         plink or tortoiseplink. This variable overrides the config setting
1033         `ssh.variant` that serves the same purpose.
1035 `GIT_ASKPASS`::
1036         If this environment variable is set, then Git commands which need to
1037         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
1038         will call this program with a suitable prompt as command-line argument
1039         and read the password from its STDOUT. See also the `core.askPass`
1040         option in linkgit:git-config[1].
1042 `GIT_TERMINAL_PROMPT`::
1043         If this environment variable is set to `0`, git will not prompt
1044         on the terminal (e.g., when asking for HTTP authentication).
1046 `GIT_CONFIG_NOSYSTEM`::
1047         Whether to skip reading settings from the system-wide
1048         `$(prefix)/etc/gitconfig` file.  This environment variable can
1049         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
1050         predictable environment for a picky script, or you can set it
1051         temporarily to avoid using a buggy `/etc/gitconfig` file while
1052         waiting for someone with sufficient permissions to fix it.
1054 `GIT_FLUSH`::
1055         If this environment variable is set to "1", then commands such
1056         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1057         'git check-attr' and 'git check-ignore' will
1058         force a flush of the output stream after each record have been
1059         flushed. If this
1060         variable is set to "0", the output of these commands will be done
1061         using completely buffered I/O.   If this environment variable is
1062         not set, Git will choose buffered or record-oriented flushing
1063         based on whether stdout appears to be redirected to a file or not.
1065 `GIT_TRACE`::
1066         Enables general trace messages, e.g. alias expansion, built-in
1067         command execution and external command execution.
1069 If this variable is set to "1", "2" or "true" (comparison
1070 is case insensitive), trace messages will be printed to
1071 stderr.
1073 If the variable is set to an integer value greater than 2
1074 and lower than 10 (strictly) then Git will interpret this
1075 value as an open file descriptor and will try to write the
1076 trace messages into this file descriptor.
1078 Alternatively, if the variable is set to an absolute path
1079 (starting with a '/' character), Git will interpret this
1080 as a file path and will try to write the trace messages
1081 into it.
1083 Unsetting the variable, or setting it to empty, "0" or
1084 "false" (case insensitive) disables trace messages.
1086 `GIT_TRACE_PACK_ACCESS`::
1087         Enables trace messages for all accesses to any packs. For each
1088         access, the pack file name and an offset in the pack is
1089         recorded. This may be helpful for troubleshooting some
1090         pack-related performance problems.
1091         See `GIT_TRACE` for available trace output options.
1093 `GIT_TRACE_PACKET`::
1094         Enables trace messages for all packets coming in or out of a
1095         given program. This can help with debugging object negotiation
1096         or other protocol issues. Tracing is turned off at a packet
1097         starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1098         See `GIT_TRACE` for available trace output options.
1100 `GIT_TRACE_PACKFILE`::
1101         Enables tracing of packfiles sent or received by a
1102         given program. Unlike other trace output, this trace is
1103         verbatim: no headers, and no quoting of binary data. You almost
1104         certainly want to direct into a file (e.g.,
1105         `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1106         the terminal or mixing it with other trace output.
1108 Note that this is currently only implemented for the client side
1109 of clones and fetches.
1111 `GIT_TRACE_PERFORMANCE`::
1112         Enables performance related trace messages, e.g. total execution
1113         time of each Git command.
1114         See `GIT_TRACE` for available trace output options.
1116 `GIT_TRACE_SETUP`::
1117         Enables trace messages printing the .git, working tree and current
1118         working directory after Git has completed its setup phase.
1119         See `GIT_TRACE` for available trace output options.
1121 `GIT_TRACE_SHALLOW`::
1122         Enables trace messages that can help debugging fetching /
1123         cloning of shallow repositories.
1124         See `GIT_TRACE` for available trace output options.
1126 `GIT_TRACE_CURL`::
1127         Enables a curl full trace dump of all incoming and outgoing data,
1128         including descriptive information, of the git transport protocol.
1129         This is similar to doing curl `--trace-ascii` on the command line.
1130         This option overrides setting the `GIT_CURL_VERBOSE` environment
1131         variable.
1132         See `GIT_TRACE` for available trace output options.
1134 `GIT_LITERAL_PATHSPECS`::
1135         Setting this variable to `1` will cause Git to treat all
1136         pathspecs literally, rather than as glob patterns. For example,
1137         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1138         for commits that touch the path `*.c`, not any paths that the
1139         glob `*.c` matches. You might want this if you are feeding
1140         literal paths to Git (e.g., paths previously given to you by
1141         `git ls-tree`, `--raw` diff output, etc).
1143 `GIT_GLOB_PATHSPECS`::
1144         Setting this variable to `1` will cause Git to treat all
1145         pathspecs as glob patterns (aka "glob" magic).
1147 `GIT_NOGLOB_PATHSPECS`::
1148         Setting this variable to `1` will cause Git to treat all
1149         pathspecs as literal (aka "literal" magic).
1151 `GIT_ICASE_PATHSPECS`::
1152         Setting this variable to `1` will cause Git to treat all
1153         pathspecs as case-insensitive.
1155 `GIT_REFLOG_ACTION`::
1156         When a ref is updated, reflog entries are created to keep
1157         track of the reason why the ref was updated (which is
1158         typically the name of the high-level command that updated
1159         the ref), in addition to the old and new values of the ref.
1160         A scripted Porcelain command can use set_reflog_action
1161         helper function in `git-sh-setup` to set its name to this
1162         variable when it is invoked as the top level command by the
1163         end user, to be recorded in the body of the reflog.
1165 `GIT_REF_PARANOIA`::
1166         If set to `1`, include broken or badly named refs when iterating
1167         over lists of refs. In a normal, non-corrupted repository, this
1168         does nothing. However, enabling it may help git to detect and
1169         abort some operations in the presence of broken refs. Git sets
1170         this variable automatically when performing destructive
1171         operations like linkgit:git-prune[1]. You should not need to set
1172         it yourself unless you want to be paranoid about making sure
1173         an operation has touched every ref (e.g., because you are
1174         cloning a repository to make a backup).
1176 `GIT_ALLOW_PROTOCOL`::
1177         If set to a colon-separated list of protocols, behave as if
1178         `protocol.allow` is set to `never`, and each of the listed
1179         protocols has `protocol.<name>.allow` set to `always`
1180         (overriding any existing configuration). In other words, any
1181         protocol not mentioned will be disallowed (i.e., this is a
1182         whitelist, not a blacklist). See the description of
1183         `protocol.allow` in linkgit:git-config[1] for more details.
1185 `GIT_PROTOCOL_FROM_USER`::
1186         Set to 0 to prevent protocols used by fetch/push/clone which are
1187         configured to the `user` state.  This is useful to restrict recursive
1188         submodule initialization from an untrusted repository or for programs
1189         which feed potentially-untrusted URLS to git commands.  See
1190         linkgit:git-config[1] for more details.
1192 Discussion[[Discussion]]
1193 ------------------------
1195 More detail on the following is available from the
1196 link:user-manual.html#git-concepts[Git concepts chapter of the
1197 user-manual] and linkgit:gitcore-tutorial[7].
1199 A Git project normally consists of a working directory with a ".git"
1200 subdirectory at the top level.  The .git directory contains, among other
1201 things, a compressed object database representing the complete history
1202 of the project, an "index" file which links that history to the current
1203 contents of the working tree, and named pointers into that history such
1204 as tags and branch heads.
1206 The object database contains objects of three main types: blobs, which
1207 hold file data; trees, which point to blobs and other trees to build up
1208 directory hierarchies; and commits, which each reference a single tree
1209 and some number of parent commits.
1211 The commit, equivalent to what other systems call a "changeset" or
1212 "version", represents a step in the project's history, and each parent
1213 represents an immediately preceding step.  Commits with more than one
1214 parent represent merges of independent lines of development.
1216 All objects are named by the SHA-1 hash of their contents, normally
1217 written as a string of 40 hex digits.  Such names are globally unique.
1218 The entire history leading up to a commit can be vouched for by signing
1219 just that commit.  A fourth object type, the tag, is provided for this
1220 purpose.
1222 When first created, objects are stored in individual files, but for
1223 efficiency may later be compressed together into "pack files".
1225 Named pointers called refs mark interesting points in history.  A ref
1226 may contain the SHA-1 name of an object or the name of another ref.  Refs
1227 with names beginning `ref/head/` contain the SHA-1 name of the most
1228 recent commit (or "head") of a branch under development.  SHA-1 names of
1229 tags of interest are stored under `ref/tags/`.  A special ref named
1230 `HEAD` contains the name of the currently checked-out branch.
1232 The index file is initialized with a list of all paths and, for each
1233 path, a blob object and a set of attributes.  The blob object represents
1234 the contents of the file as of the head of the current branch.  The
1235 attributes (last modified time, size, etc.) are taken from the
1236 corresponding file in the working tree.  Subsequent changes to the
1237 working tree can be found by comparing these attributes.  The index may
1238 be updated with new content, and new commits may be created from the
1239 content stored in the index.
1241 The index is also capable of storing multiple entries (called "stages")
1242 for a given pathname.  These stages are used to hold the various
1243 unmerged version of a file when a merge is in progress.
1245 FURTHER DOCUMENTATION
1246 ---------------------
1248 See the references in the "description" section to get started
1249 using Git.  The following is probably more detail than necessary
1250 for a first-time user.
1252 The link:user-manual.html#git-concepts[Git concepts chapter of the
1253 user-manual] and linkgit:gitcore-tutorial[7] both provide
1254 introductions to the underlying Git architecture.
1256 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1258 See also the link:howto-index.html[howto] documents for some useful
1259 examples.
1261 The internals are documented in the
1262 link:technical/api-index.html[Git API documentation].
1264 Users migrating from CVS may also want to
1265 read linkgit:gitcvs-migration[7].
1268 Authors
1269 -------
1270 Git was started by Linus Torvalds, and is currently maintained by Junio
1271 C Hamano. Numerous contributions have come from the Git mailing list
1272 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1273 gives you a more complete list of contributors.
1275 If you have a clone of git.git itself, the
1276 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1277 the authors for specific parts of the project.
1279 Reporting Bugs
1280 --------------
1282 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1283 development and maintenance is primarily done.  You do not have to be
1284 subscribed to the list to send a message there.
1286 SEE ALSO
1287 --------
1288 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1289 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1290 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1291 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1292 linkgit:gitworkflows[7]
1296 Part of the linkgit:git[1] suite