Merge branch 'maint-2.10' into maint-2.11
[git/gitweb.git] / Documentation / git.txt
blob2a663e5b576d064d6e7be813026bb062cf2bd6c0
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.11.1/git.html[documentation for release 2.11.1]
49 * release notes for
50   link:RelNotes/2.11.1.txt[2.11.1],
51   link:RelNotes/2.11.0.txt[2.11].
53 * link:v2.10.3/git.html[documentation for release 2.10.3]
55 * release notes for
56   link:RelNotes/2.10.3.txt[2.10.3],
57   link:RelNotes/2.10.2.txt[2.10.2],
58   link:RelNotes/2.10.1.txt[2.10.1],
59   link:RelNotes/2.10.0.txt[2.10].
61 * link:v2.9.4/git.html[documentation for release 2.9.4]
63 * release notes for
64   link:RelNotes/2.9.4.txt[2.9.4],
65   link:RelNotes/2.9.3.txt[2.9.3],
66   link:RelNotes/2.9.2.txt[2.9.2],
67   link:RelNotes/2.9.1.txt[2.9.1],
68   link:RelNotes/2.9.0.txt[2.9].
70 * link:v2.8.5/git.html[documentation for release 2.8.5]
72 * release notes for
73   link:RelNotes/2.8.5.txt[2.8.5],
74   link:RelNotes/2.8.4.txt[2.8.4],
75   link:RelNotes/2.8.3.txt[2.8.3],
76   link:RelNotes/2.8.2.txt[2.8.2],
77   link:RelNotes/2.8.1.txt[2.8.1],
78   link:RelNotes/2.8.0.txt[2.8].
80 * link:v2.7.5/git.html[documentation for release 2.7.5]
82 * release notes for
83   link:RelNotes/2.7.5.txt[2.7.5],
84   link:RelNotes/2.7.4.txt[2.7.4],
85   link:RelNotes/2.7.3.txt[2.7.3],
86   link:RelNotes/2.7.2.txt[2.7.2],
87   link:RelNotes/2.7.1.txt[2.7.1],
88   link:RelNotes/2.7.0.txt[2.7].
90 * link:v2.6.7/git.html[documentation for release 2.6.7]
92 * release notes for
93   link:RelNotes/2.6.7.txt[2.6.7],
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.6/git.html[documentation for release 2.5.6]
104 * release notes for
105   link:RelNotes/2.5.6.txt[2.5.6],
106   link:RelNotes/2.5.5.txt[2.5.5],
107   link:RelNotes/2.5.4.txt[2.5.4],
108   link:RelNotes/2.5.3.txt[2.5.3],
109   link:RelNotes/2.5.2.txt[2.5.2],
110   link:RelNotes/2.5.1.txt[2.5.1],
111   link:RelNotes/2.5.0.txt[2.5].
113 * link:v2.4.12/git.html[documentation for release 2.4.12]
115 * release notes for
116   link:RelNotes/2.4.12.txt[2.4.12],
117   link:RelNotes/2.4.11.txt[2.4.11],
118   link:RelNotes/2.4.10.txt[2.4.10],
119   link:RelNotes/2.4.9.txt[2.4.9],
120   link:RelNotes/2.4.8.txt[2.4.8],
121   link:RelNotes/2.4.7.txt[2.4.7],
122   link:RelNotes/2.4.6.txt[2.4.6],
123   link:RelNotes/2.4.5.txt[2.4.5],
124   link:RelNotes/2.4.4.txt[2.4.4],
125   link:RelNotes/2.4.3.txt[2.4.3],
126   link:RelNotes/2.4.2.txt[2.4.2],
127   link:RelNotes/2.4.1.txt[2.4.1],
128   link:RelNotes/2.4.0.txt[2.4].
130 * link:v2.3.10/git.html[documentation for release 2.3.10]
132 * release notes for
133   link:RelNotes/2.3.10.txt[2.3.10],
134   link:RelNotes/2.3.9.txt[2.3.9],
135   link:RelNotes/2.3.8.txt[2.3.8],
136   link:RelNotes/2.3.7.txt[2.3.7],
137   link:RelNotes/2.3.6.txt[2.3.6],
138   link:RelNotes/2.3.5.txt[2.3.5],
139   link:RelNotes/2.3.4.txt[2.3.4],
140   link:RelNotes/2.3.3.txt[2.3.3],
141   link:RelNotes/2.3.2.txt[2.3.2],
142   link:RelNotes/2.3.1.txt[2.3.1],
143   link:RelNotes/2.3.0.txt[2.3].
145 * link:v2.2.3/git.html[documentation for release 2.2.3]
147 * release notes for
148   link:RelNotes/2.2.3.txt[2.2.3],
149   link:RelNotes/2.2.2.txt[2.2.2],
150   link:RelNotes/2.2.1.txt[2.2.1],
151   link:RelNotes/2.2.0.txt[2.2].
153 * link:v2.1.4/git.html[documentation for release 2.1.4]
155 * release notes for
156   link:RelNotes/2.1.4.txt[2.1.4],
157   link:RelNotes/2.1.3.txt[2.1.3],
158   link:RelNotes/2.1.2.txt[2.1.2],
159   link:RelNotes/2.1.1.txt[2.1.1],
160   link:RelNotes/2.1.0.txt[2.1].
162 * link:v2.0.5/git.html[documentation for release 2.0.5]
164 * release notes for
165   link:RelNotes/2.0.5.txt[2.0.5],
166   link:RelNotes/2.0.4.txt[2.0.4],
167   link:RelNotes/2.0.3.txt[2.0.3],
168   link:RelNotes/2.0.2.txt[2.0.2],
169   link:RelNotes/2.0.1.txt[2.0.1],
170   link:RelNotes/2.0.0.txt[2.0.0].
172 * link:v1.9.5/git.html[documentation for release 1.9.5]
174 * release notes for
175   link:RelNotes/1.9.5.txt[1.9.5],
176   link:RelNotes/1.9.4.txt[1.9.4],
177   link:RelNotes/1.9.3.txt[1.9.3],
178   link:RelNotes/1.9.2.txt[1.9.2],
179   link:RelNotes/1.9.1.txt[1.9.1],
180   link:RelNotes/1.9.0.txt[1.9.0].
182 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
184 * release notes for
185   link:RelNotes/1.8.5.6.txt[1.8.5.6],
186   link:RelNotes/1.8.5.5.txt[1.8.5.5],
187   link:RelNotes/1.8.5.4.txt[1.8.5.4],
188   link:RelNotes/1.8.5.3.txt[1.8.5.3],
189   link:RelNotes/1.8.5.2.txt[1.8.5.2],
190   link:RelNotes/1.8.5.1.txt[1.8.5.1],
191   link:RelNotes/1.8.5.txt[1.8.5].
193 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
195 * release notes for
196   link:RelNotes/1.8.4.5.txt[1.8.4.5],
197   link:RelNotes/1.8.4.4.txt[1.8.4.4],
198   link:RelNotes/1.8.4.3.txt[1.8.4.3],
199   link:RelNotes/1.8.4.2.txt[1.8.4.2],
200   link:RelNotes/1.8.4.1.txt[1.8.4.1],
201   link:RelNotes/1.8.4.txt[1.8.4].
203 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
205 * release notes for
206   link:RelNotes/1.8.3.4.txt[1.8.3.4],
207   link:RelNotes/1.8.3.3.txt[1.8.3.3],
208   link:RelNotes/1.8.3.2.txt[1.8.3.2],
209   link:RelNotes/1.8.3.1.txt[1.8.3.1],
210   link:RelNotes/1.8.3.txt[1.8.3].
212 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
214 * release notes for
215   link:RelNotes/1.8.2.3.txt[1.8.2.3],
216   link:RelNotes/1.8.2.2.txt[1.8.2.2],
217   link:RelNotes/1.8.2.1.txt[1.8.2.1],
218   link:RelNotes/1.8.2.txt[1.8.2].
220 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
222 * release notes for
223   link:RelNotes/1.8.1.6.txt[1.8.1.6],
224   link:RelNotes/1.8.1.5.txt[1.8.1.5],
225   link:RelNotes/1.8.1.4.txt[1.8.1.4],
226   link:RelNotes/1.8.1.3.txt[1.8.1.3],
227   link:RelNotes/1.8.1.2.txt[1.8.1.2],
228   link:RelNotes/1.8.1.1.txt[1.8.1.1],
229   link:RelNotes/1.8.1.txt[1.8.1].
231 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
233 * release notes for
234   link:RelNotes/1.8.0.3.txt[1.8.0.3],
235   link:RelNotes/1.8.0.2.txt[1.8.0.2],
236   link:RelNotes/1.8.0.1.txt[1.8.0.1],
237   link:RelNotes/1.8.0.txt[1.8.0].
239 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
241 * release notes for
242   link:RelNotes/1.7.12.4.txt[1.7.12.4],
243   link:RelNotes/1.7.12.3.txt[1.7.12.3],
244   link:RelNotes/1.7.12.2.txt[1.7.12.2],
245   link:RelNotes/1.7.12.1.txt[1.7.12.1],
246   link:RelNotes/1.7.12.txt[1.7.12].
248 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
250 * release notes for
251   link:RelNotes/1.7.11.7.txt[1.7.11.7],
252   link:RelNotes/1.7.11.6.txt[1.7.11.6],
253   link:RelNotes/1.7.11.5.txt[1.7.11.5],
254   link:RelNotes/1.7.11.4.txt[1.7.11.4],
255   link:RelNotes/1.7.11.3.txt[1.7.11.3],
256   link:RelNotes/1.7.11.2.txt[1.7.11.2],
257   link:RelNotes/1.7.11.1.txt[1.7.11.1],
258   link:RelNotes/1.7.11.txt[1.7.11].
260 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
262 * release notes for
263   link:RelNotes/1.7.10.5.txt[1.7.10.5],
264   link:RelNotes/1.7.10.4.txt[1.7.10.4],
265   link:RelNotes/1.7.10.3.txt[1.7.10.3],
266   link:RelNotes/1.7.10.2.txt[1.7.10.2],
267   link:RelNotes/1.7.10.1.txt[1.7.10.1],
268   link:RelNotes/1.7.10.txt[1.7.10].
270 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
272 * release notes for
273   link:RelNotes/1.7.9.7.txt[1.7.9.7],
274   link:RelNotes/1.7.9.6.txt[1.7.9.6],
275   link:RelNotes/1.7.9.5.txt[1.7.9.5],
276   link:RelNotes/1.7.9.4.txt[1.7.9.4],
277   link:RelNotes/1.7.9.3.txt[1.7.9.3],
278   link:RelNotes/1.7.9.2.txt[1.7.9.2],
279   link:RelNotes/1.7.9.1.txt[1.7.9.1],
280   link:RelNotes/1.7.9.txt[1.7.9].
282 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
284 * release notes for
285   link:RelNotes/1.7.8.6.txt[1.7.8.6],
286   link:RelNotes/1.7.8.5.txt[1.7.8.5],
287   link:RelNotes/1.7.8.4.txt[1.7.8.4],
288   link:RelNotes/1.7.8.3.txt[1.7.8.3],
289   link:RelNotes/1.7.8.2.txt[1.7.8.2],
290   link:RelNotes/1.7.8.1.txt[1.7.8.1],
291   link:RelNotes/1.7.8.txt[1.7.8].
293 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
295 * release notes for
296   link:RelNotes/1.7.7.7.txt[1.7.7.7],
297   link:RelNotes/1.7.7.6.txt[1.7.7.6],
298   link:RelNotes/1.7.7.5.txt[1.7.7.5],
299   link:RelNotes/1.7.7.4.txt[1.7.7.4],
300   link:RelNotes/1.7.7.3.txt[1.7.7.3],
301   link:RelNotes/1.7.7.2.txt[1.7.7.2],
302   link:RelNotes/1.7.7.1.txt[1.7.7.1],
303   link:RelNotes/1.7.7.txt[1.7.7].
305 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
307 * release notes for
308   link:RelNotes/1.7.6.6.txt[1.7.6.6],
309   link:RelNotes/1.7.6.5.txt[1.7.6.5],
310   link:RelNotes/1.7.6.4.txt[1.7.6.4],
311   link:RelNotes/1.7.6.3.txt[1.7.6.3],
312   link:RelNotes/1.7.6.2.txt[1.7.6.2],
313   link:RelNotes/1.7.6.1.txt[1.7.6.1],
314   link:RelNotes/1.7.6.txt[1.7.6].
316 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
318 * release notes for
319   link:RelNotes/1.7.5.4.txt[1.7.5.4],
320   link:RelNotes/1.7.5.3.txt[1.7.5.3],
321   link:RelNotes/1.7.5.2.txt[1.7.5.2],
322   link:RelNotes/1.7.5.1.txt[1.7.5.1],
323   link:RelNotes/1.7.5.txt[1.7.5].
325 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
327 * release notes for
328   link:RelNotes/1.7.4.5.txt[1.7.4.5],
329   link:RelNotes/1.7.4.4.txt[1.7.4.4],
330   link:RelNotes/1.7.4.3.txt[1.7.4.3],
331   link:RelNotes/1.7.4.2.txt[1.7.4.2],
332   link:RelNotes/1.7.4.1.txt[1.7.4.1],
333   link:RelNotes/1.7.4.txt[1.7.4].
335 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
337 * release notes for
338   link:RelNotes/1.7.3.5.txt[1.7.3.5],
339   link:RelNotes/1.7.3.4.txt[1.7.3.4],
340   link:RelNotes/1.7.3.3.txt[1.7.3.3],
341   link:RelNotes/1.7.3.2.txt[1.7.3.2],
342   link:RelNotes/1.7.3.1.txt[1.7.3.1],
343   link:RelNotes/1.7.3.txt[1.7.3].
345 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
347 * release notes for
348   link:RelNotes/1.7.2.5.txt[1.7.2.5],
349   link:RelNotes/1.7.2.4.txt[1.7.2.4],
350   link:RelNotes/1.7.2.3.txt[1.7.2.3],
351   link:RelNotes/1.7.2.2.txt[1.7.2.2],
352   link:RelNotes/1.7.2.1.txt[1.7.2.1],
353   link:RelNotes/1.7.2.txt[1.7.2].
355 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
357 * release notes for
358   link:RelNotes/1.7.1.4.txt[1.7.1.4],
359   link:RelNotes/1.7.1.3.txt[1.7.1.3],
360   link:RelNotes/1.7.1.2.txt[1.7.1.2],
361   link:RelNotes/1.7.1.1.txt[1.7.1.1],
362   link:RelNotes/1.7.1.txt[1.7.1].
364 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
366 * release notes for
367   link:RelNotes/1.7.0.9.txt[1.7.0.9],
368   link:RelNotes/1.7.0.8.txt[1.7.0.8],
369   link:RelNotes/1.7.0.7.txt[1.7.0.7],
370   link:RelNotes/1.7.0.6.txt[1.7.0.6],
371   link:RelNotes/1.7.0.5.txt[1.7.0.5],
372   link:RelNotes/1.7.0.4.txt[1.7.0.4],
373   link:RelNotes/1.7.0.3.txt[1.7.0.3],
374   link:RelNotes/1.7.0.2.txt[1.7.0.2],
375   link:RelNotes/1.7.0.1.txt[1.7.0.1],
376   link:RelNotes/1.7.0.txt[1.7.0].
378 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
380 * release notes for
381   link:RelNotes/1.6.6.3.txt[1.6.6.3],
382   link:RelNotes/1.6.6.2.txt[1.6.6.2],
383   link:RelNotes/1.6.6.1.txt[1.6.6.1],
384   link:RelNotes/1.6.6.txt[1.6.6].
386 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
388 * release notes for
389   link:RelNotes/1.6.5.9.txt[1.6.5.9],
390   link:RelNotes/1.6.5.8.txt[1.6.5.8],
391   link:RelNotes/1.6.5.7.txt[1.6.5.7],
392   link:RelNotes/1.6.5.6.txt[1.6.5.6],
393   link:RelNotes/1.6.5.5.txt[1.6.5.5],
394   link:RelNotes/1.6.5.4.txt[1.6.5.4],
395   link:RelNotes/1.6.5.3.txt[1.6.5.3],
396   link:RelNotes/1.6.5.2.txt[1.6.5.2],
397   link:RelNotes/1.6.5.1.txt[1.6.5.1],
398   link:RelNotes/1.6.5.txt[1.6.5].
400 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
402 * release notes for
403   link:RelNotes/1.6.4.5.txt[1.6.4.5],
404   link:RelNotes/1.6.4.4.txt[1.6.4.4],
405   link:RelNotes/1.6.4.3.txt[1.6.4.3],
406   link:RelNotes/1.6.4.2.txt[1.6.4.2],
407   link:RelNotes/1.6.4.1.txt[1.6.4.1],
408   link:RelNotes/1.6.4.txt[1.6.4].
410 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
412 * release notes for
413   link:RelNotes/1.6.3.4.txt[1.6.3.4],
414   link:RelNotes/1.6.3.3.txt[1.6.3.3],
415   link:RelNotes/1.6.3.2.txt[1.6.3.2],
416   link:RelNotes/1.6.3.1.txt[1.6.3.1],
417   link:RelNotes/1.6.3.txt[1.6.3].
419 * release notes for
420   link:RelNotes/1.6.2.5.txt[1.6.2.5],
421   link:RelNotes/1.6.2.4.txt[1.6.2.4],
422   link:RelNotes/1.6.2.3.txt[1.6.2.3],
423   link:RelNotes/1.6.2.2.txt[1.6.2.2],
424   link:RelNotes/1.6.2.1.txt[1.6.2.1],
425   link:RelNotes/1.6.2.txt[1.6.2].
427 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
429 * release notes for
430   link:RelNotes/1.6.1.3.txt[1.6.1.3],
431   link:RelNotes/1.6.1.2.txt[1.6.1.2],
432   link:RelNotes/1.6.1.1.txt[1.6.1.1],
433   link:RelNotes/1.6.1.txt[1.6.1].
435 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
437 * release notes for
438   link:RelNotes/1.6.0.6.txt[1.6.0.6],
439   link:RelNotes/1.6.0.5.txt[1.6.0.5],
440   link:RelNotes/1.6.0.4.txt[1.6.0.4],
441   link:RelNotes/1.6.0.3.txt[1.6.0.3],
442   link:RelNotes/1.6.0.2.txt[1.6.0.2],
443   link:RelNotes/1.6.0.1.txt[1.6.0.1],
444   link:RelNotes/1.6.0.txt[1.6.0].
446 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
448 * release notes for
449   link:RelNotes/1.5.6.6.txt[1.5.6.6],
450   link:RelNotes/1.5.6.5.txt[1.5.6.5],
451   link:RelNotes/1.5.6.4.txt[1.5.6.4],
452   link:RelNotes/1.5.6.3.txt[1.5.6.3],
453   link:RelNotes/1.5.6.2.txt[1.5.6.2],
454   link:RelNotes/1.5.6.1.txt[1.5.6.1],
455   link:RelNotes/1.5.6.txt[1.5.6].
457 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
459 * release notes for
460   link:RelNotes/1.5.5.6.txt[1.5.5.6],
461   link:RelNotes/1.5.5.5.txt[1.5.5.5],
462   link:RelNotes/1.5.5.4.txt[1.5.5.4],
463   link:RelNotes/1.5.5.3.txt[1.5.5.3],
464   link:RelNotes/1.5.5.2.txt[1.5.5.2],
465   link:RelNotes/1.5.5.1.txt[1.5.5.1],
466   link:RelNotes/1.5.5.txt[1.5.5].
468 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
470 * release notes for
471   link:RelNotes/1.5.4.7.txt[1.5.4.7],
472   link:RelNotes/1.5.4.6.txt[1.5.4.6],
473   link:RelNotes/1.5.4.5.txt[1.5.4.5],
474   link:RelNotes/1.5.4.4.txt[1.5.4.4],
475   link:RelNotes/1.5.4.3.txt[1.5.4.3],
476   link:RelNotes/1.5.4.2.txt[1.5.4.2],
477   link:RelNotes/1.5.4.1.txt[1.5.4.1],
478   link:RelNotes/1.5.4.txt[1.5.4].
480 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
482 * release notes for
483   link:RelNotes/1.5.3.8.txt[1.5.3.8],
484   link:RelNotes/1.5.3.7.txt[1.5.3.7],
485   link:RelNotes/1.5.3.6.txt[1.5.3.6],
486   link:RelNotes/1.5.3.5.txt[1.5.3.5],
487   link:RelNotes/1.5.3.4.txt[1.5.3.4],
488   link:RelNotes/1.5.3.3.txt[1.5.3.3],
489   link:RelNotes/1.5.3.2.txt[1.5.3.2],
490   link:RelNotes/1.5.3.1.txt[1.5.3.1],
491   link:RelNotes/1.5.3.txt[1.5.3].
493 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
495 * release notes for
496   link:RelNotes/1.5.2.5.txt[1.5.2.5],
497   link:RelNotes/1.5.2.4.txt[1.5.2.4],
498   link:RelNotes/1.5.2.3.txt[1.5.2.3],
499   link:RelNotes/1.5.2.2.txt[1.5.2.2],
500   link:RelNotes/1.5.2.1.txt[1.5.2.1],
501   link:RelNotes/1.5.2.txt[1.5.2].
503 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
505 * release notes for
506   link:RelNotes/1.5.1.6.txt[1.5.1.6],
507   link:RelNotes/1.5.1.5.txt[1.5.1.5],
508   link:RelNotes/1.5.1.4.txt[1.5.1.4],
509   link:RelNotes/1.5.1.3.txt[1.5.1.3],
510   link:RelNotes/1.5.1.2.txt[1.5.1.2],
511   link:RelNotes/1.5.1.1.txt[1.5.1.1],
512   link:RelNotes/1.5.1.txt[1.5.1].
514 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
516 * release notes for
517   link:RelNotes/1.5.0.7.txt[1.5.0.7],
518   link:RelNotes/1.5.0.6.txt[1.5.0.6],
519   link:RelNotes/1.5.0.5.txt[1.5.0.5],
520   link:RelNotes/1.5.0.3.txt[1.5.0.3],
521   link:RelNotes/1.5.0.2.txt[1.5.0.2],
522   link:RelNotes/1.5.0.1.txt[1.5.0.1],
523   link:RelNotes/1.5.0.txt[1.5.0].
525 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
526   link:v1.3.3/git.html[1.3.3],
527   link:v1.2.6/git.html[1.2.6],
528   link:v1.0.13/git.html[1.0.13].
530 ============
532 endif::stalenotes[]
534 OPTIONS
535 -------
536 --version::
537         Prints the Git suite version that the 'git' program came from.
539 --help::
540         Prints the synopsis and a list of the most commonly used
541         commands. If the option `--all` or `-a` is given then all
542         available commands are printed. If a Git command is named this
543         option will bring up the manual page for that command.
545 Other options are available to control how the manual page is
546 displayed. See linkgit:git-help[1] for more information,
547 because `git --help ...` is converted internally into `git
548 help ...`.
550 -C <path>::
551         Run as if git was started in '<path>' instead of the current working
552         directory.  When multiple `-C` options are given, each subsequent
553         non-absolute `-C <path>` is interpreted relative to the preceding `-C
554         <path>`.
556 This option affects options that expect path name like `--git-dir` and
557 `--work-tree` in that their interpretations of the path names would be
558 made relative to the working directory caused by the `-C` option. For
559 example the following invocations are equivalent:
561     git --git-dir=a.git --work-tree=b -C c status
562     git --git-dir=c/a.git --work-tree=c/b status
564 -c <name>=<value>::
565         Pass a configuration parameter to the command. The value
566         given will override values from configuration files.
567         The <name> is expected in the same format as listed by
568         'git config' (subkeys separated by dots).
570 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
571 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
572 config file). Including the equals but with an empty value (like `git -c
573 foo.bar= ...`) sets `foo.bar` to the empty string.
575 --exec-path[=<path>]::
576         Path to wherever your core Git programs are installed.
577         This can also be controlled by setting the GIT_EXEC_PATH
578         environment variable. If no path is given, 'git' will print
579         the current setting and then exit.
581 --html-path::
582         Print the path, without trailing slash, where Git's HTML
583         documentation is installed and exit.
585 --man-path::
586         Print the manpath (see `man(1)`) for the man pages for
587         this version of Git and exit.
589 --info-path::
590         Print the path where the Info files documenting this
591         version of Git are installed and exit.
593 -p::
594 --paginate::
595         Pipe all output into 'less' (or if set, $PAGER) if standard
596         output is a terminal.  This overrides the `pager.<cmd>`
597         configuration options (see the "Configuration Mechanism" section
598         below).
600 --no-pager::
601         Do not pipe Git output into a pager.
603 --git-dir=<path>::
604         Set the path to the repository. This can also be controlled by
605         setting the `GIT_DIR` environment variable. It can be an absolute
606         path or relative path to current working directory.
608 --work-tree=<path>::
609         Set the path to the working tree. It can be an absolute path
610         or a path relative to the current working directory.
611         This can also be controlled by setting the GIT_WORK_TREE
612         environment variable and the core.worktree configuration
613         variable (see core.worktree in linkgit:git-config[1] for a
614         more detailed discussion).
616 --namespace=<path>::
617         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
618         details.  Equivalent to setting the `GIT_NAMESPACE` environment
619         variable.
621 --super-prefix=<path>::
622         Currently for internal use only.  Set a prefix which gives a path from
623         above a repository down to its root.  One use is to give submodules
624         context about the superproject that invoked it.
626 --bare::
627         Treat the repository as a bare repository.  If GIT_DIR
628         environment is not set, it is set to the current working
629         directory.
631 --no-replace-objects::
632         Do not use replacement refs to replace Git objects. See
633         linkgit:git-replace[1] for more information.
635 --literal-pathspecs::
636         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
637         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
638         variable to `1`.
640 --glob-pathspecs::
641         Add "glob" magic to all pathspec. This is equivalent to setting
642         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
643         globbing on individual pathspecs can be done using pathspec
644         magic ":(literal)"
646 --noglob-pathspecs::
647         Add "literal" magic to all pathspec. This is equivalent to setting
648         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
649         globbing on individual pathspecs can be done using pathspec
650         magic ":(glob)"
652 --icase-pathspecs::
653         Add "icase" magic to all pathspec. This is equivalent to setting
654         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
656 GIT COMMANDS
657 ------------
659 We divide Git into high level ("porcelain") commands and low level
660 ("plumbing") commands.
662 High-level commands (porcelain)
663 -------------------------------
665 We separate the porcelain commands into the main commands and some
666 ancillary user utilities.
668 Main porcelain commands
669 ~~~~~~~~~~~~~~~~~~~~~~~
671 include::cmds-mainporcelain.txt[]
673 Ancillary Commands
674 ~~~~~~~~~~~~~~~~~~
675 Manipulators:
677 include::cmds-ancillarymanipulators.txt[]
679 Interrogators:
681 include::cmds-ancillaryinterrogators.txt[]
684 Interacting with Others
685 ~~~~~~~~~~~~~~~~~~~~~~~
687 These commands are to interact with foreign SCM and with other
688 people via patch over e-mail.
690 include::cmds-foreignscminterface.txt[]
693 Low-level commands (plumbing)
694 -----------------------------
696 Although Git includes its
697 own porcelain layer, its low-level commands are sufficient to support
698 development of alternative porcelains.  Developers of such porcelains
699 might start by reading about linkgit:git-update-index[1] and
700 linkgit:git-read-tree[1].
702 The interface (input, output, set of options and the semantics)
703 to these low-level commands are meant to be a lot more stable
704 than Porcelain level commands, because these commands are
705 primarily for scripted use.  The interface to Porcelain commands
706 on the other hand are subject to change in order to improve the
707 end user experience.
709 The following description divides
710 the low-level commands into commands that manipulate objects (in
711 the repository, index, and working tree), commands that interrogate and
712 compare objects, and commands that move objects and references between
713 repositories.
716 Manipulation commands
717 ~~~~~~~~~~~~~~~~~~~~~
719 include::cmds-plumbingmanipulators.txt[]
722 Interrogation commands
723 ~~~~~~~~~~~~~~~~~~~~~~
725 include::cmds-plumbinginterrogators.txt[]
727 In general, the interrogate commands do not touch the files in
728 the working tree.
731 Synching repositories
732 ~~~~~~~~~~~~~~~~~~~~~
734 include::cmds-synchingrepositories.txt[]
736 The following are helper commands used by the above; end users
737 typically do not use them directly.
739 include::cmds-synchelpers.txt[]
742 Internal helper commands
743 ~~~~~~~~~~~~~~~~~~~~~~~~
745 These are internal helper commands used by other commands; end
746 users typically do not use them directly.
748 include::cmds-purehelpers.txt[]
751 Configuration Mechanism
752 -----------------------
754 Git uses a simple text format to store customizations that are per
755 repository and are per user.  Such a configuration file may look
756 like this:
758 ------------
760 # A '#' or ';' character indicates a comment.
763 ; core variables
764 [core]
765         ; Don't trust file modes
766         filemode = false
768 ; user identity
769 [user]
770         name = "Junio C Hamano"
771         email = "gitster@pobox.com"
773 ------------
775 Various commands read from the configuration file and adjust
776 their operation accordingly.  See linkgit:git-config[1] for a
777 list and more details about the configuration mechanism.
780 Identifier Terminology
781 ----------------------
782 <object>::
783         Indicates the object name for any type of object.
785 <blob>::
786         Indicates a blob object name.
788 <tree>::
789         Indicates a tree object name.
791 <commit>::
792         Indicates a commit object name.
794 <tree-ish>::
795         Indicates a tree, commit or tag object name.  A
796         command that takes a <tree-ish> argument ultimately wants to
797         operate on a <tree> object but automatically dereferences
798         <commit> and <tag> objects that point at a <tree>.
800 <commit-ish>::
801         Indicates a commit or tag object name.  A
802         command that takes a <commit-ish> argument ultimately wants to
803         operate on a <commit> object but automatically dereferences
804         <tag> objects that point at a <commit>.
806 <type>::
807         Indicates that an object type is required.
808         Currently one of: `blob`, `tree`, `commit`, or `tag`.
810 <file>::
811         Indicates a filename - almost always relative to the
812         root of the tree structure `GIT_INDEX_FILE` describes.
814 Symbolic Identifiers
815 --------------------
816 Any Git command accepting any <object> can also use the following
817 symbolic notation:
819 HEAD::
820         indicates the head of the current branch.
822 <tag>::
823         a valid tag 'name'
824         (i.e. a `refs/tags/<tag>` reference).
826 <head>::
827         a valid head 'name'
828         (i.e. a `refs/heads/<head>` reference).
830 For a more complete list of ways to spell object names, see
831 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
834 File/Directory Structure
835 ------------------------
837 Please see the linkgit:gitrepository-layout[5] document.
839 Read linkgit:githooks[5] for more details about each hook.
841 Higher level SCMs may provide and manage additional information in the
842 `$GIT_DIR`.
845 Terminology
846 -----------
847 Please see linkgit:gitglossary[7].
850 Environment Variables
851 ---------------------
852 Various Git commands use the following environment variables:
854 The Git Repository
855 ~~~~~~~~~~~~~~~~~~
856 These environment variables apply to 'all' core Git commands. Nb: it
857 is worth noting that they may be used/overridden by SCMS sitting above
858 Git so take care if using a foreign front-end.
860 `GIT_INDEX_FILE`::
861         This environment allows the specification of an alternate
862         index file. If not specified, the default of `$GIT_DIR/index`
863         is used.
865 `GIT_INDEX_VERSION`::
866         This environment variable allows the specification of an index
867         version for new repositories.  It won't affect existing index
868         files.  By default index file version 2 or 3 is used. See
869         linkgit:git-update-index[1] for more information.
871 `GIT_OBJECT_DIRECTORY`::
872         If the object storage directory is specified via this
873         environment variable then the sha1 directories are created
874         underneath - otherwise the default `$GIT_DIR/objects`
875         directory is used.
877 `GIT_ALTERNATE_OBJECT_DIRECTORIES`::
878         Due to the immutable nature of Git objects, old objects can be
879         archived into shared, read-only directories. This variable
880         specifies a ":" separated (on Windows ";" separated) list
881         of Git object directories which can be used to search for Git
882         objects. New objects will not be written to these directories.
884         Entries that begin with `"` (double-quote) will be interpreted
885         as C-style quoted paths, removing leading and trailing
886         double-quotes and respecting backslash escapes. E.g., the value
887         `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
888         `path-with-"-and-:-in-it` and `vanilla-path`.
890 `GIT_DIR`::
891         If the `GIT_DIR` environment variable is set then it
892         specifies a path to use instead of the default `.git`
893         for the base of the repository.
894         The `--git-dir` command-line option also sets this value.
896 `GIT_WORK_TREE`::
897         Set the path to the root of the working tree.
898         This can also be controlled by the `--work-tree` command-line
899         option and the core.worktree configuration variable.
901 `GIT_NAMESPACE`::
902         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
903         The `--namespace` command-line option also sets this value.
905 `GIT_CEILING_DIRECTORIES`::
906         This should be a colon-separated list of absolute paths.  If
907         set, it is a list of directories that Git should not chdir up
908         into while looking for a repository directory (useful for
909         excluding slow-loading network directories).  It will not
910         exclude the current working directory or a GIT_DIR set on the
911         command line or in the environment.  Normally, Git has to read
912         the entries in this list and resolve any symlink that
913         might be present in order to compare them with the current
914         directory.  However, if even this access is slow, you
915         can add an empty entry to the list to tell Git that the
916         subsequent entries are not symlinks and needn't be resolved;
917         e.g.,
918         `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
920 `GIT_DISCOVERY_ACROSS_FILESYSTEM`::
921         When run in a directory that does not have ".git" repository
922         directory, Git tries to find such a directory in the parent
923         directories to find the top of the working tree, but by default it
924         does not cross filesystem boundaries.  This environment variable
925         can be set to true to tell Git not to stop at filesystem
926         boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
927         an explicit repository directory set via `GIT_DIR` or on the
928         command line.
930 `GIT_COMMON_DIR`::
931         If this variable is set to a path, non-worktree files that are
932         normally in $GIT_DIR will be taken from this path
933         instead. Worktree-specific files such as HEAD or index are
934         taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
935         linkgit:git-worktree[1] for
936         details. This variable has lower precedence than other path
937         variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
939 Git Commits
940 ~~~~~~~~~~~
941 `GIT_AUTHOR_NAME`::
942 `GIT_AUTHOR_EMAIL`::
943 `GIT_AUTHOR_DATE`::
944 `GIT_COMMITTER_NAME`::
945 `GIT_COMMITTER_EMAIL`::
946 `GIT_COMMITTER_DATE`::
947 'EMAIL'::
948         see linkgit:git-commit-tree[1]
950 Git Diffs
951 ~~~~~~~~~
952 `GIT_DIFF_OPTS`::
953         Only valid setting is "--unified=??" or "-u??" to set the
954         number of context lines shown when a unified diff is created.
955         This takes precedence over any "-U" or "--unified" option
956         value passed on the Git diff command line.
958 `GIT_EXTERNAL_DIFF`::
959         When the environment variable `GIT_EXTERNAL_DIFF` is set, the
960         program named by it is called, instead of the diff invocation
961         described above.  For a path that is added, removed, or modified,
962         `GIT_EXTERNAL_DIFF` is called with 7 parameters:
964         path old-file old-hex old-mode new-file new-hex new-mode
966 where:
968         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
969                          contents of <old|new>,
970         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
971         <old|new>-mode:: are the octal representation of the file modes.
973 The file parameters can point at the user's working file
974 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
975 when a new file is added), or a temporary file (e.g. `old-file` in the
976 index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
977 temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
979 For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
980 parameter, <path>.
982 For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
983 `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
985 `GIT_DIFF_PATH_COUNTER`::
986         A 1-based counter incremented by one for every path.
988 `GIT_DIFF_PATH_TOTAL`::
989         The total number of paths.
991 other
992 ~~~~~
993 `GIT_MERGE_VERBOSITY`::
994         A number controlling the amount of output shown by
995         the recursive merge strategy.  Overrides merge.verbosity.
996         See linkgit:git-merge[1]
998 `GIT_PAGER`::
999         This environment variable overrides `$PAGER`. If it is set
1000         to an empty string or to the value "cat", Git will not launch
1001         a pager.  See also the `core.pager` option in
1002         linkgit:git-config[1].
1004 `GIT_EDITOR`::
1005         This environment variable overrides `$EDITOR` and `$VISUAL`.
1006         It is used by several Git commands when, on interactive mode,
1007         an editor is to be launched. See also linkgit:git-var[1]
1008         and the `core.editor` option in linkgit:git-config[1].
1010 `GIT_SSH`::
1011 `GIT_SSH_COMMAND`::
1012         If either of these environment variables is set then 'git fetch'
1013         and 'git push' will use the specified command instead of 'ssh'
1014         when they need to connect to a remote system.
1015         The command will be given exactly two or four arguments: the
1016         'username@host' (or just 'host') from the URL and the shell
1017         command to execute on that remote system, optionally preceded by
1018         `-p` (literally) and the 'port' from the URL when it specifies
1019         something other than the default SSH port.
1021 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
1022 by the shell, which allows additional arguments to be included.
1023 `$GIT_SSH` on the other hand must be just the path to a program
1024 (which can be a wrapper shell script, if additional arguments are
1025 needed).
1027 Usually it is easier to configure any desired options through your
1028 personal `.ssh/config` file.  Please consult your ssh documentation
1029 for further details.
1031 `GIT_ASKPASS`::
1032         If this environment variable is set, then Git commands which need to
1033         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
1034         will call this program with a suitable prompt as command-line argument
1035         and read the password from its STDOUT. See also the `core.askPass`
1036         option in linkgit:git-config[1].
1038 `GIT_TERMINAL_PROMPT`::
1039         If this environment variable is set to `0`, git will not prompt
1040         on the terminal (e.g., when asking for HTTP authentication).
1042 `GIT_CONFIG_NOSYSTEM`::
1043         Whether to skip reading settings from the system-wide
1044         `$(prefix)/etc/gitconfig` file.  This environment variable can
1045         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
1046         predictable environment for a picky script, or you can set it
1047         temporarily to avoid using a buggy `/etc/gitconfig` file while
1048         waiting for someone with sufficient permissions to fix it.
1050 `GIT_FLUSH`::
1051         If this environment variable is set to "1", then commands such
1052         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1053         'git check-attr' and 'git check-ignore' will
1054         force a flush of the output stream after each record have been
1055         flushed. If this
1056         variable is set to "0", the output of these commands will be done
1057         using completely buffered I/O.   If this environment variable is
1058         not set, Git will choose buffered or record-oriented flushing
1059         based on whether stdout appears to be redirected to a file or not.
1061 `GIT_TRACE`::
1062         Enables general trace messages, e.g. alias expansion, built-in
1063         command execution and external command execution.
1065 If this variable is set to "1", "2" or "true" (comparison
1066 is case insensitive), trace messages will be printed to
1067 stderr.
1069 If the variable is set to an integer value greater than 2
1070 and lower than 10 (strictly) then Git will interpret this
1071 value as an open file descriptor and will try to write the
1072 trace messages into this file descriptor.
1074 Alternatively, if the variable is set to an absolute path
1075 (starting with a '/' character), Git will interpret this
1076 as a file path and will try to write the trace messages
1077 into it.
1079 Unsetting the variable, or setting it to empty, "0" or
1080 "false" (case insensitive) disables trace messages.
1082 `GIT_TRACE_PACK_ACCESS`::
1083         Enables trace messages for all accesses to any packs. For each
1084         access, the pack file name and an offset in the pack is
1085         recorded. This may be helpful for troubleshooting some
1086         pack-related performance problems.
1087         See `GIT_TRACE` for available trace output options.
1089 `GIT_TRACE_PACKET`::
1090         Enables trace messages for all packets coming in or out of a
1091         given program. This can help with debugging object negotiation
1092         or other protocol issues. Tracing is turned off at a packet
1093         starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1094         See `GIT_TRACE` for available trace output options.
1096 `GIT_TRACE_PACKFILE`::
1097         Enables tracing of packfiles sent or received by a
1098         given program. Unlike other trace output, this trace is
1099         verbatim: no headers, and no quoting of binary data. You almost
1100         certainly want to direct into a file (e.g.,
1101         `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1102         the terminal or mixing it with other trace output.
1104 Note that this is currently only implemented for the client side
1105 of clones and fetches.
1107 `GIT_TRACE_PERFORMANCE`::
1108         Enables performance related trace messages, e.g. total execution
1109         time of each Git command.
1110         See `GIT_TRACE` for available trace output options.
1112 `GIT_TRACE_SETUP`::
1113         Enables trace messages printing the .git, working tree and current
1114         working directory after Git has completed its setup phase.
1115         See `GIT_TRACE` for available trace output options.
1117 `GIT_TRACE_SHALLOW`::
1118         Enables trace messages that can help debugging fetching /
1119         cloning of shallow repositories.
1120         See `GIT_TRACE` for available trace output options.
1122 `GIT_TRACE_CURL`::
1123         Enables a curl full trace dump of all incoming and outgoing data,
1124         including descriptive information, of the git transport protocol.
1125         This is similar to doing curl `--trace-ascii` on the command line.
1126         This option overrides setting the `GIT_CURL_VERBOSE` environment
1127         variable.
1128         See `GIT_TRACE` for available trace output options.
1130 `GIT_LITERAL_PATHSPECS`::
1131         Setting this variable to `1` will cause Git to treat all
1132         pathspecs literally, rather than as glob patterns. For example,
1133         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1134         for commits that touch the path `*.c`, not any paths that the
1135         glob `*.c` matches. You might want this if you are feeding
1136         literal paths to Git (e.g., paths previously given to you by
1137         `git ls-tree`, `--raw` diff output, etc).
1139 `GIT_GLOB_PATHSPECS`::
1140         Setting this variable to `1` will cause Git to treat all
1141         pathspecs as glob patterns (aka "glob" magic).
1143 `GIT_NOGLOB_PATHSPECS`::
1144         Setting this variable to `1` will cause Git to treat all
1145         pathspecs as literal (aka "literal" magic).
1147 `GIT_ICASE_PATHSPECS`::
1148         Setting this variable to `1` will cause Git to treat all
1149         pathspecs as case-insensitive.
1151 `GIT_REFLOG_ACTION`::
1152         When a ref is updated, reflog entries are created to keep
1153         track of the reason why the ref was updated (which is
1154         typically the name of the high-level command that updated
1155         the ref), in addition to the old and new values of the ref.
1156         A scripted Porcelain command can use set_reflog_action
1157         helper function in `git-sh-setup` to set its name to this
1158         variable when it is invoked as the top level command by the
1159         end user, to be recorded in the body of the reflog.
1161 `GIT_REF_PARANOIA`::
1162         If set to `1`, include broken or badly named refs when iterating
1163         over lists of refs. In a normal, non-corrupted repository, this
1164         does nothing. However, enabling it may help git to detect and
1165         abort some operations in the presence of broken refs. Git sets
1166         this variable automatically when performing destructive
1167         operations like linkgit:git-prune[1]. You should not need to set
1168         it yourself unless you want to be paranoid about making sure
1169         an operation has touched every ref (e.g., because you are
1170         cloning a repository to make a backup).
1172 `GIT_ALLOW_PROTOCOL`::
1173         If set, provide a colon-separated list of protocols which are
1174         allowed to be used with fetch/push/clone. This is useful to
1175         restrict recursive submodule initialization from an untrusted
1176         repository. Any protocol not mentioned will be disallowed (i.e.,
1177         this is a whitelist, not a blacklist). If the variable is not
1178         set at all, all protocols are enabled.  The protocol names
1179         currently used by git are:
1181           - `file`: any local file-based path (including `file://` URLs,
1182             or local paths)
1184           - `git`: the anonymous git protocol over a direct TCP
1185             connection (or proxy, if configured)
1187           - `ssh`: git over ssh (including `host:path` syntax,
1188             `ssh://`, etc).
1190           - `http`: git over http, both "smart http" and "dumb http".
1191             Note that this does _not_ include `https`; if you want both,
1192             you should specify both as `http:https`.
1194           - any external helpers are named by their protocol (e.g., use
1195             `hg` to allow the `git-remote-hg` helper)
1198 Discussion[[Discussion]]
1199 ------------------------
1201 More detail on the following is available from the
1202 link:user-manual.html#git-concepts[Git concepts chapter of the
1203 user-manual] and linkgit:gitcore-tutorial[7].
1205 A Git project normally consists of a working directory with a ".git"
1206 subdirectory at the top level.  The .git directory contains, among other
1207 things, a compressed object database representing the complete history
1208 of the project, an "index" file which links that history to the current
1209 contents of the working tree, and named pointers into that history such
1210 as tags and branch heads.
1212 The object database contains objects of three main types: blobs, which
1213 hold file data; trees, which point to blobs and other trees to build up
1214 directory hierarchies; and commits, which each reference a single tree
1215 and some number of parent commits.
1217 The commit, equivalent to what other systems call a "changeset" or
1218 "version", represents a step in the project's history, and each parent
1219 represents an immediately preceding step.  Commits with more than one
1220 parent represent merges of independent lines of development.
1222 All objects are named by the SHA-1 hash of their contents, normally
1223 written as a string of 40 hex digits.  Such names are globally unique.
1224 The entire history leading up to a commit can be vouched for by signing
1225 just that commit.  A fourth object type, the tag, is provided for this
1226 purpose.
1228 When first created, objects are stored in individual files, but for
1229 efficiency may later be compressed together into "pack files".
1231 Named pointers called refs mark interesting points in history.  A ref
1232 may contain the SHA-1 name of an object or the name of another ref.  Refs
1233 with names beginning `ref/head/` contain the SHA-1 name of the most
1234 recent commit (or "head") of a branch under development.  SHA-1 names of
1235 tags of interest are stored under `ref/tags/`.  A special ref named
1236 `HEAD` contains the name of the currently checked-out branch.
1238 The index file is initialized with a list of all paths and, for each
1239 path, a blob object and a set of attributes.  The blob object represents
1240 the contents of the file as of the head of the current branch.  The
1241 attributes (last modified time, size, etc.) are taken from the
1242 corresponding file in the working tree.  Subsequent changes to the
1243 working tree can be found by comparing these attributes.  The index may
1244 be updated with new content, and new commits may be created from the
1245 content stored in the index.
1247 The index is also capable of storing multiple entries (called "stages")
1248 for a given pathname.  These stages are used to hold the various
1249 unmerged version of a file when a merge is in progress.
1251 FURTHER DOCUMENTATION
1252 ---------------------
1254 See the references in the "description" section to get started
1255 using Git.  The following is probably more detail than necessary
1256 for a first-time user.
1258 The link:user-manual.html#git-concepts[Git concepts chapter of the
1259 user-manual] and linkgit:gitcore-tutorial[7] both provide
1260 introductions to the underlying Git architecture.
1262 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1264 See also the link:howto-index.html[howto] documents for some useful
1265 examples.
1267 The internals are documented in the
1268 link:technical/api-index.html[Git API documentation].
1270 Users migrating from CVS may also want to
1271 read linkgit:gitcvs-migration[7].
1274 Authors
1275 -------
1276 Git was started by Linus Torvalds, and is currently maintained by Junio
1277 C Hamano. Numerous contributions have come from the Git mailing list
1278 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1279 gives you a more complete list of contributors.
1281 If you have a clone of git.git itself, the
1282 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1283 the authors for specific parts of the project.
1285 Reporting Bugs
1286 --------------
1288 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1289 development and maintenance is primarily done.  You do not have to be
1290 subscribed to the list to send a message there.
1292 SEE ALSO
1293 --------
1294 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1295 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1296 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1297 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1298 linkgit:gitworkflows[7]
1302 Part of the linkgit:git[1] suite