sync with girocco/v2.11.4+
[git/gitweb.git] / Documentation / git.txt
blobcc215361f130f197df8655584a8b6e768dced475
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.2/git.html[documentation for release 2.11.2]
49 * release notes for
50   link:RelNotes/2.11.2.txt[2.11.2],
51   link:RelNotes/2.11.1.txt[2.11.1],
52   link:RelNotes/2.11.0.txt[2.11].
54 * link:v2.10.3/git.html[documentation for release 2.10.3]
56 * release notes for
57   link:RelNotes/2.10.3.txt[2.10.3],
58   link:RelNotes/2.10.2.txt[2.10.2],
59   link:RelNotes/2.10.1.txt[2.10.1],
60   link:RelNotes/2.10.0.txt[2.10].
62 * link:v2.9.4/git.html[documentation for release 2.9.4]
64 * release notes for
65   link:RelNotes/2.9.4.txt[2.9.4],
66   link:RelNotes/2.9.3.txt[2.9.3],
67   link:RelNotes/2.9.2.txt[2.9.2],
68   link:RelNotes/2.9.1.txt[2.9.1],
69   link:RelNotes/2.9.0.txt[2.9].
71 * link:v2.8.5/git.html[documentation for release 2.8.5]
73 * release notes for
74   link:RelNotes/2.8.5.txt[2.8.5],
75   link:RelNotes/2.8.4.txt[2.8.4],
76   link:RelNotes/2.8.3.txt[2.8.3],
77   link:RelNotes/2.8.2.txt[2.8.2],
78   link:RelNotes/2.8.1.txt[2.8.1],
79   link:RelNotes/2.8.0.txt[2.8].
81 * link:v2.7.5/git.html[documentation for release 2.7.5]
83 * release notes for
84   link:RelNotes/2.7.5.txt[2.7.5],
85   link:RelNotes/2.7.4.txt[2.7.4],
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.7/git.html[documentation for release 2.6.7]
93 * release notes for
94   link:RelNotes/2.6.7.txt[2.6.7],
95   link:RelNotes/2.6.6.txt[2.6.6],
96   link:RelNotes/2.6.5.txt[2.6.5],
97   link:RelNotes/2.6.4.txt[2.6.4],
98   link:RelNotes/2.6.3.txt[2.6.3],
99   link:RelNotes/2.6.2.txt[2.6.2],
100   link:RelNotes/2.6.1.txt[2.6.1],
101   link:RelNotes/2.6.0.txt[2.6].
103 * link:v2.5.6/git.html[documentation for release 2.5.6]
105 * release notes for
106   link:RelNotes/2.5.6.txt[2.5.6],
107   link:RelNotes/2.5.5.txt[2.5.5],
108   link:RelNotes/2.5.4.txt[2.5.4],
109   link:RelNotes/2.5.3.txt[2.5.3],
110   link:RelNotes/2.5.2.txt[2.5.2],
111   link:RelNotes/2.5.1.txt[2.5.1],
112   link:RelNotes/2.5.0.txt[2.5].
114 * link:v2.4.12/git.html[documentation for release 2.4.12]
116 * release notes for
117   link:RelNotes/2.4.12.txt[2.4.12],
118   link:RelNotes/2.4.11.txt[2.4.11],
119   link:RelNotes/2.4.10.txt[2.4.10],
120   link:RelNotes/2.4.9.txt[2.4.9],
121   link:RelNotes/2.4.8.txt[2.4.8],
122   link:RelNotes/2.4.7.txt[2.4.7],
123   link:RelNotes/2.4.6.txt[2.4.6],
124   link:RelNotes/2.4.5.txt[2.4.5],
125   link:RelNotes/2.4.4.txt[2.4.4],
126   link:RelNotes/2.4.3.txt[2.4.3],
127   link:RelNotes/2.4.2.txt[2.4.2],
128   link:RelNotes/2.4.1.txt[2.4.1],
129   link:RelNotes/2.4.0.txt[2.4].
131 * link:v2.3.10/git.html[documentation for release 2.3.10]
133 * release notes for
134   link:RelNotes/2.3.10.txt[2.3.10],
135   link:RelNotes/2.3.9.txt[2.3.9],
136   link:RelNotes/2.3.8.txt[2.3.8],
137   link:RelNotes/2.3.7.txt[2.3.7],
138   link:RelNotes/2.3.6.txt[2.3.6],
139   link:RelNotes/2.3.5.txt[2.3.5],
140   link:RelNotes/2.3.4.txt[2.3.4],
141   link:RelNotes/2.3.3.txt[2.3.3],
142   link:RelNotes/2.3.2.txt[2.3.2],
143   link:RelNotes/2.3.1.txt[2.3.1],
144   link:RelNotes/2.3.0.txt[2.3].
146 * link:v2.2.3/git.html[documentation for release 2.2.3]
148 * release notes for
149   link:RelNotes/2.2.3.txt[2.2.3],
150   link:RelNotes/2.2.2.txt[2.2.2],
151   link:RelNotes/2.2.1.txt[2.2.1],
152   link:RelNotes/2.2.0.txt[2.2].
154 * link:v2.1.4/git.html[documentation for release 2.1.4]
156 * release notes for
157   link:RelNotes/2.1.4.txt[2.1.4],
158   link:RelNotes/2.1.3.txt[2.1.3],
159   link:RelNotes/2.1.2.txt[2.1.2],
160   link:RelNotes/2.1.1.txt[2.1.1],
161   link:RelNotes/2.1.0.txt[2.1].
163 * link:v2.0.5/git.html[documentation for release 2.0.5]
165 * release notes for
166   link:RelNotes/2.0.5.txt[2.0.5],
167   link:RelNotes/2.0.4.txt[2.0.4],
168   link:RelNotes/2.0.3.txt[2.0.3],
169   link:RelNotes/2.0.2.txt[2.0.2],
170   link:RelNotes/2.0.1.txt[2.0.1],
171   link:RelNotes/2.0.0.txt[2.0.0].
173 * link:v1.9.5/git.html[documentation for release 1.9.5]
175 * release notes for
176   link:RelNotes/1.9.5.txt[1.9.5],
177   link:RelNotes/1.9.4.txt[1.9.4],
178   link:RelNotes/1.9.3.txt[1.9.3],
179   link:RelNotes/1.9.2.txt[1.9.2],
180   link:RelNotes/1.9.1.txt[1.9.1],
181   link:RelNotes/1.9.0.txt[1.9.0].
183 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
185 * release notes for
186   link:RelNotes/1.8.5.6.txt[1.8.5.6],
187   link:RelNotes/1.8.5.5.txt[1.8.5.5],
188   link:RelNotes/1.8.5.4.txt[1.8.5.4],
189   link:RelNotes/1.8.5.3.txt[1.8.5.3],
190   link:RelNotes/1.8.5.2.txt[1.8.5.2],
191   link:RelNotes/1.8.5.1.txt[1.8.5.1],
192   link:RelNotes/1.8.5.txt[1.8.5].
194 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
196 * release notes for
197   link:RelNotes/1.8.4.5.txt[1.8.4.5],
198   link:RelNotes/1.8.4.4.txt[1.8.4.4],
199   link:RelNotes/1.8.4.3.txt[1.8.4.3],
200   link:RelNotes/1.8.4.2.txt[1.8.4.2],
201   link:RelNotes/1.8.4.1.txt[1.8.4.1],
202   link:RelNotes/1.8.4.txt[1.8.4].
204 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
206 * release notes for
207   link:RelNotes/1.8.3.4.txt[1.8.3.4],
208   link:RelNotes/1.8.3.3.txt[1.8.3.3],
209   link:RelNotes/1.8.3.2.txt[1.8.3.2],
210   link:RelNotes/1.8.3.1.txt[1.8.3.1],
211   link:RelNotes/1.8.3.txt[1.8.3].
213 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
215 * release notes for
216   link:RelNotes/1.8.2.3.txt[1.8.2.3],
217   link:RelNotes/1.8.2.2.txt[1.8.2.2],
218   link:RelNotes/1.8.2.1.txt[1.8.2.1],
219   link:RelNotes/1.8.2.txt[1.8.2].
221 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
223 * release notes for
224   link:RelNotes/1.8.1.6.txt[1.8.1.6],
225   link:RelNotes/1.8.1.5.txt[1.8.1.5],
226   link:RelNotes/1.8.1.4.txt[1.8.1.4],
227   link:RelNotes/1.8.1.3.txt[1.8.1.3],
228   link:RelNotes/1.8.1.2.txt[1.8.1.2],
229   link:RelNotes/1.8.1.1.txt[1.8.1.1],
230   link:RelNotes/1.8.1.txt[1.8.1].
232 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
234 * release notes for
235   link:RelNotes/1.8.0.3.txt[1.8.0.3],
236   link:RelNotes/1.8.0.2.txt[1.8.0.2],
237   link:RelNotes/1.8.0.1.txt[1.8.0.1],
238   link:RelNotes/1.8.0.txt[1.8.0].
240 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
242 * release notes for
243   link:RelNotes/1.7.12.4.txt[1.7.12.4],
244   link:RelNotes/1.7.12.3.txt[1.7.12.3],
245   link:RelNotes/1.7.12.2.txt[1.7.12.2],
246   link:RelNotes/1.7.12.1.txt[1.7.12.1],
247   link:RelNotes/1.7.12.txt[1.7.12].
249 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
251 * release notes for
252   link:RelNotes/1.7.11.7.txt[1.7.11.7],
253   link:RelNotes/1.7.11.6.txt[1.7.11.6],
254   link:RelNotes/1.7.11.5.txt[1.7.11.5],
255   link:RelNotes/1.7.11.4.txt[1.7.11.4],
256   link:RelNotes/1.7.11.3.txt[1.7.11.3],
257   link:RelNotes/1.7.11.2.txt[1.7.11.2],
258   link:RelNotes/1.7.11.1.txt[1.7.11.1],
259   link:RelNotes/1.7.11.txt[1.7.11].
261 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
263 * release notes for
264   link:RelNotes/1.7.10.5.txt[1.7.10.5],
265   link:RelNotes/1.7.10.4.txt[1.7.10.4],
266   link:RelNotes/1.7.10.3.txt[1.7.10.3],
267   link:RelNotes/1.7.10.2.txt[1.7.10.2],
268   link:RelNotes/1.7.10.1.txt[1.7.10.1],
269   link:RelNotes/1.7.10.txt[1.7.10].
271 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
273 * release notes for
274   link:RelNotes/1.7.9.7.txt[1.7.9.7],
275   link:RelNotes/1.7.9.6.txt[1.7.9.6],
276   link:RelNotes/1.7.9.5.txt[1.7.9.5],
277   link:RelNotes/1.7.9.4.txt[1.7.9.4],
278   link:RelNotes/1.7.9.3.txt[1.7.9.3],
279   link:RelNotes/1.7.9.2.txt[1.7.9.2],
280   link:RelNotes/1.7.9.1.txt[1.7.9.1],
281   link:RelNotes/1.7.9.txt[1.7.9].
283 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
285 * release notes for
286   link:RelNotes/1.7.8.6.txt[1.7.8.6],
287   link:RelNotes/1.7.8.5.txt[1.7.8.5],
288   link:RelNotes/1.7.8.4.txt[1.7.8.4],
289   link:RelNotes/1.7.8.3.txt[1.7.8.3],
290   link:RelNotes/1.7.8.2.txt[1.7.8.2],
291   link:RelNotes/1.7.8.1.txt[1.7.8.1],
292   link:RelNotes/1.7.8.txt[1.7.8].
294 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
296 * release notes for
297   link:RelNotes/1.7.7.7.txt[1.7.7.7],
298   link:RelNotes/1.7.7.6.txt[1.7.7.6],
299   link:RelNotes/1.7.7.5.txt[1.7.7.5],
300   link:RelNotes/1.7.7.4.txt[1.7.7.4],
301   link:RelNotes/1.7.7.3.txt[1.7.7.3],
302   link:RelNotes/1.7.7.2.txt[1.7.7.2],
303   link:RelNotes/1.7.7.1.txt[1.7.7.1],
304   link:RelNotes/1.7.7.txt[1.7.7].
306 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
308 * release notes for
309   link:RelNotes/1.7.6.6.txt[1.7.6.6],
310   link:RelNotes/1.7.6.5.txt[1.7.6.5],
311   link:RelNotes/1.7.6.4.txt[1.7.6.4],
312   link:RelNotes/1.7.6.3.txt[1.7.6.3],
313   link:RelNotes/1.7.6.2.txt[1.7.6.2],
314   link:RelNotes/1.7.6.1.txt[1.7.6.1],
315   link:RelNotes/1.7.6.txt[1.7.6].
317 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
319 * release notes for
320   link:RelNotes/1.7.5.4.txt[1.7.5.4],
321   link:RelNotes/1.7.5.3.txt[1.7.5.3],
322   link:RelNotes/1.7.5.2.txt[1.7.5.2],
323   link:RelNotes/1.7.5.1.txt[1.7.5.1],
324   link:RelNotes/1.7.5.txt[1.7.5].
326 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
328 * release notes for
329   link:RelNotes/1.7.4.5.txt[1.7.4.5],
330   link:RelNotes/1.7.4.4.txt[1.7.4.4],
331   link:RelNotes/1.7.4.3.txt[1.7.4.3],
332   link:RelNotes/1.7.4.2.txt[1.7.4.2],
333   link:RelNotes/1.7.4.1.txt[1.7.4.1],
334   link:RelNotes/1.7.4.txt[1.7.4].
336 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
338 * release notes for
339   link:RelNotes/1.7.3.5.txt[1.7.3.5],
340   link:RelNotes/1.7.3.4.txt[1.7.3.4],
341   link:RelNotes/1.7.3.3.txt[1.7.3.3],
342   link:RelNotes/1.7.3.2.txt[1.7.3.2],
343   link:RelNotes/1.7.3.1.txt[1.7.3.1],
344   link:RelNotes/1.7.3.txt[1.7.3].
346 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
348 * release notes for
349   link:RelNotes/1.7.2.5.txt[1.7.2.5],
350   link:RelNotes/1.7.2.4.txt[1.7.2.4],
351   link:RelNotes/1.7.2.3.txt[1.7.2.3],
352   link:RelNotes/1.7.2.2.txt[1.7.2.2],
353   link:RelNotes/1.7.2.1.txt[1.7.2.1],
354   link:RelNotes/1.7.2.txt[1.7.2].
356 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
358 * release notes for
359   link:RelNotes/1.7.1.4.txt[1.7.1.4],
360   link:RelNotes/1.7.1.3.txt[1.7.1.3],
361   link:RelNotes/1.7.1.2.txt[1.7.1.2],
362   link:RelNotes/1.7.1.1.txt[1.7.1.1],
363   link:RelNotes/1.7.1.txt[1.7.1].
365 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
367 * release notes for
368   link:RelNotes/1.7.0.9.txt[1.7.0.9],
369   link:RelNotes/1.7.0.8.txt[1.7.0.8],
370   link:RelNotes/1.7.0.7.txt[1.7.0.7],
371   link:RelNotes/1.7.0.6.txt[1.7.0.6],
372   link:RelNotes/1.7.0.5.txt[1.7.0.5],
373   link:RelNotes/1.7.0.4.txt[1.7.0.4],
374   link:RelNotes/1.7.0.3.txt[1.7.0.3],
375   link:RelNotes/1.7.0.2.txt[1.7.0.2],
376   link:RelNotes/1.7.0.1.txt[1.7.0.1],
377   link:RelNotes/1.7.0.txt[1.7.0].
379 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
381 * release notes for
382   link:RelNotes/1.6.6.3.txt[1.6.6.3],
383   link:RelNotes/1.6.6.2.txt[1.6.6.2],
384   link:RelNotes/1.6.6.1.txt[1.6.6.1],
385   link:RelNotes/1.6.6.txt[1.6.6].
387 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
389 * release notes for
390   link:RelNotes/1.6.5.9.txt[1.6.5.9],
391   link:RelNotes/1.6.5.8.txt[1.6.5.8],
392   link:RelNotes/1.6.5.7.txt[1.6.5.7],
393   link:RelNotes/1.6.5.6.txt[1.6.5.6],
394   link:RelNotes/1.6.5.5.txt[1.6.5.5],
395   link:RelNotes/1.6.5.4.txt[1.6.5.4],
396   link:RelNotes/1.6.5.3.txt[1.6.5.3],
397   link:RelNotes/1.6.5.2.txt[1.6.5.2],
398   link:RelNotes/1.6.5.1.txt[1.6.5.1],
399   link:RelNotes/1.6.5.txt[1.6.5].
401 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
403 * release notes for
404   link:RelNotes/1.6.4.5.txt[1.6.4.5],
405   link:RelNotes/1.6.4.4.txt[1.6.4.4],
406   link:RelNotes/1.6.4.3.txt[1.6.4.3],
407   link:RelNotes/1.6.4.2.txt[1.6.4.2],
408   link:RelNotes/1.6.4.1.txt[1.6.4.1],
409   link:RelNotes/1.6.4.txt[1.6.4].
411 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
413 * release notes for
414   link:RelNotes/1.6.3.4.txt[1.6.3.4],
415   link:RelNotes/1.6.3.3.txt[1.6.3.3],
416   link:RelNotes/1.6.3.2.txt[1.6.3.2],
417   link:RelNotes/1.6.3.1.txt[1.6.3.1],
418   link:RelNotes/1.6.3.txt[1.6.3].
420 * release notes for
421   link:RelNotes/1.6.2.5.txt[1.6.2.5],
422   link:RelNotes/1.6.2.4.txt[1.6.2.4],
423   link:RelNotes/1.6.2.3.txt[1.6.2.3],
424   link:RelNotes/1.6.2.2.txt[1.6.2.2],
425   link:RelNotes/1.6.2.1.txt[1.6.2.1],
426   link:RelNotes/1.6.2.txt[1.6.2].
428 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
430 * release notes for
431   link:RelNotes/1.6.1.3.txt[1.6.1.3],
432   link:RelNotes/1.6.1.2.txt[1.6.1.2],
433   link:RelNotes/1.6.1.1.txt[1.6.1.1],
434   link:RelNotes/1.6.1.txt[1.6.1].
436 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
438 * release notes for
439   link:RelNotes/1.6.0.6.txt[1.6.0.6],
440   link:RelNotes/1.6.0.5.txt[1.6.0.5],
441   link:RelNotes/1.6.0.4.txt[1.6.0.4],
442   link:RelNotes/1.6.0.3.txt[1.6.0.3],
443   link:RelNotes/1.6.0.2.txt[1.6.0.2],
444   link:RelNotes/1.6.0.1.txt[1.6.0.1],
445   link:RelNotes/1.6.0.txt[1.6.0].
447 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
449 * release notes for
450   link:RelNotes/1.5.6.6.txt[1.5.6.6],
451   link:RelNotes/1.5.6.5.txt[1.5.6.5],
452   link:RelNotes/1.5.6.4.txt[1.5.6.4],
453   link:RelNotes/1.5.6.3.txt[1.5.6.3],
454   link:RelNotes/1.5.6.2.txt[1.5.6.2],
455   link:RelNotes/1.5.6.1.txt[1.5.6.1],
456   link:RelNotes/1.5.6.txt[1.5.6].
458 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
460 * release notes for
461   link:RelNotes/1.5.5.6.txt[1.5.5.6],
462   link:RelNotes/1.5.5.5.txt[1.5.5.5],
463   link:RelNotes/1.5.5.4.txt[1.5.5.4],
464   link:RelNotes/1.5.5.3.txt[1.5.5.3],
465   link:RelNotes/1.5.5.2.txt[1.5.5.2],
466   link:RelNotes/1.5.5.1.txt[1.5.5.1],
467   link:RelNotes/1.5.5.txt[1.5.5].
469 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
471 * release notes for
472   link:RelNotes/1.5.4.7.txt[1.5.4.7],
473   link:RelNotes/1.5.4.6.txt[1.5.4.6],
474   link:RelNotes/1.5.4.5.txt[1.5.4.5],
475   link:RelNotes/1.5.4.4.txt[1.5.4.4],
476   link:RelNotes/1.5.4.3.txt[1.5.4.3],
477   link:RelNotes/1.5.4.2.txt[1.5.4.2],
478   link:RelNotes/1.5.4.1.txt[1.5.4.1],
479   link:RelNotes/1.5.4.txt[1.5.4].
481 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
483 * release notes for
484   link:RelNotes/1.5.3.8.txt[1.5.3.8],
485   link:RelNotes/1.5.3.7.txt[1.5.3.7],
486   link:RelNotes/1.5.3.6.txt[1.5.3.6],
487   link:RelNotes/1.5.3.5.txt[1.5.3.5],
488   link:RelNotes/1.5.3.4.txt[1.5.3.4],
489   link:RelNotes/1.5.3.3.txt[1.5.3.3],
490   link:RelNotes/1.5.3.2.txt[1.5.3.2],
491   link:RelNotes/1.5.3.1.txt[1.5.3.1],
492   link:RelNotes/1.5.3.txt[1.5.3].
494 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
496 * release notes for
497   link:RelNotes/1.5.2.5.txt[1.5.2.5],
498   link:RelNotes/1.5.2.4.txt[1.5.2.4],
499   link:RelNotes/1.5.2.3.txt[1.5.2.3],
500   link:RelNotes/1.5.2.2.txt[1.5.2.2],
501   link:RelNotes/1.5.2.1.txt[1.5.2.1],
502   link:RelNotes/1.5.2.txt[1.5.2].
504 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
506 * release notes for
507   link:RelNotes/1.5.1.6.txt[1.5.1.6],
508   link:RelNotes/1.5.1.5.txt[1.5.1.5],
509   link:RelNotes/1.5.1.4.txt[1.5.1.4],
510   link:RelNotes/1.5.1.3.txt[1.5.1.3],
511   link:RelNotes/1.5.1.2.txt[1.5.1.2],
512   link:RelNotes/1.5.1.1.txt[1.5.1.1],
513   link:RelNotes/1.5.1.txt[1.5.1].
515 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
517 * release notes for
518   link:RelNotes/1.5.0.7.txt[1.5.0.7],
519   link:RelNotes/1.5.0.6.txt[1.5.0.6],
520   link:RelNotes/1.5.0.5.txt[1.5.0.5],
521   link:RelNotes/1.5.0.3.txt[1.5.0.3],
522   link:RelNotes/1.5.0.2.txt[1.5.0.2],
523   link:RelNotes/1.5.0.1.txt[1.5.0.1],
524   link:RelNotes/1.5.0.txt[1.5.0].
526 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
527   link:v1.3.3/git.html[1.3.3],
528   link:v1.2.6/git.html[1.2.6],
529   link:v1.0.13/git.html[1.0.13].
531 ============
533 endif::stalenotes[]
535 OPTIONS
536 -------
537 --version::
538         Prints the Git suite version that the 'git' program came from.
540 --help::
541         Prints the synopsis and a list of the most commonly used
542         commands. If the option `--all` or `-a` is given then all
543         available commands are printed. If a Git command is named this
544         option will bring up the manual page for that command.
546 Other options are available to control how the manual page is
547 displayed. See linkgit:git-help[1] for more information,
548 because `git --help ...` is converted internally into `git
549 help ...`.
551 -C <path>::
552         Run as if git was started in '<path>' instead of the current working
553         directory.  When multiple `-C` options are given, each subsequent
554         non-absolute `-C <path>` is interpreted relative to the preceding `-C
555         <path>`.
557 This option affects options that expect path name like `--git-dir` and
558 `--work-tree` in that their interpretations of the path names would be
559 made relative to the working directory caused by the `-C` option. For
560 example the following invocations are equivalent:
562     git --git-dir=a.git --work-tree=b -C c status
563     git --git-dir=c/a.git --work-tree=c/b status
565 -c <name>=<value>::
566         Pass a configuration parameter to the command. The value
567         given will override values from configuration files.
568         The <name> is expected in the same format as listed by
569         'git config' (subkeys separated by dots).
571 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
572 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
573 config file). Including the equals but with an empty value (like `git -c
574 foo.bar= ...`) sets `foo.bar` to the empty string.
576 --exec-path[=<path>]::
577         Path to wherever your core Git programs are installed.
578         This can also be controlled by setting the GIT_EXEC_PATH
579         environment variable. If no path is given, 'git' will print
580         the current setting and then exit.
582 --html-path::
583         Print the path, without trailing slash, where Git's HTML
584         documentation is installed and exit.
586 --man-path::
587         Print the manpath (see `man(1)`) for the man pages for
588         this version of Git and exit.
590 --info-path::
591         Print the path where the Info files documenting this
592         version of Git are installed and exit.
594 -p::
595 --paginate::
596         Pipe all output into 'less' (or if set, $PAGER) if standard
597         output is a terminal.  This overrides the `pager.<cmd>`
598         configuration options (see the "Configuration Mechanism" section
599         below).
601 --no-pager::
602         Do not pipe Git output into a pager.
604 --git-dir=<path>::
605         Set the path to the repository. This can also be controlled by
606         setting the `GIT_DIR` environment variable. It can be an absolute
607         path or relative path to current working directory.
609 --work-tree=<path>::
610         Set the path to the working tree. It can be an absolute path
611         or a path relative to the current working directory.
612         This can also be controlled by setting the GIT_WORK_TREE
613         environment variable and the core.worktree configuration
614         variable (see core.worktree in linkgit:git-config[1] for a
615         more detailed discussion).
617 --namespace=<path>::
618         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
619         details.  Equivalent to setting the `GIT_NAMESPACE` environment
620         variable.
622 --super-prefix=<path>::
623         Currently for internal use only.  Set a prefix which gives a path from
624         above a repository down to its root.  One use is to give submodules
625         context about the superproject that invoked it.
627 --bare::
628         Treat the repository as a bare repository.  If GIT_DIR
629         environment is not set, it is set to the current working
630         directory.
632 --no-replace-objects::
633         Do not use replacement refs to replace Git objects. See
634         linkgit:git-replace[1] for more information.
636 --literal-pathspecs::
637         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
638         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
639         variable to `1`.
641 --glob-pathspecs::
642         Add "glob" magic to all pathspec. This is equivalent to setting
643         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
644         globbing on individual pathspecs can be done using pathspec
645         magic ":(literal)"
647 --noglob-pathspecs::
648         Add "literal" magic to all pathspec. This is equivalent to setting
649         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
650         globbing on individual pathspecs can be done using pathspec
651         magic ":(glob)"
653 --icase-pathspecs::
654         Add "icase" magic to all pathspec. This is equivalent to setting
655         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
657 GIT COMMANDS
658 ------------
660 We divide Git into high level ("porcelain") commands and low level
661 ("plumbing") commands.
663 High-level commands (porcelain)
664 -------------------------------
666 We separate the porcelain commands into the main commands and some
667 ancillary user utilities.
669 Main porcelain commands
670 ~~~~~~~~~~~~~~~~~~~~~~~
672 include::cmds-mainporcelain.txt[]
674 Ancillary Commands
675 ~~~~~~~~~~~~~~~~~~
676 Manipulators:
678 include::cmds-ancillarymanipulators.txt[]
680 Interrogators:
682 include::cmds-ancillaryinterrogators.txt[]
685 Interacting with Others
686 ~~~~~~~~~~~~~~~~~~~~~~~
688 These commands are to interact with foreign SCM and with other
689 people via patch over e-mail.
691 include::cmds-foreignscminterface.txt[]
694 Low-level commands (plumbing)
695 -----------------------------
697 Although Git includes its
698 own porcelain layer, its low-level commands are sufficient to support
699 development of alternative porcelains.  Developers of such porcelains
700 might start by reading about linkgit:git-update-index[1] and
701 linkgit:git-read-tree[1].
703 The interface (input, output, set of options and the semantics)
704 to these low-level commands are meant to be a lot more stable
705 than Porcelain level commands, because these commands are
706 primarily for scripted use.  The interface to Porcelain commands
707 on the other hand are subject to change in order to improve the
708 end user experience.
710 The following description divides
711 the low-level commands into commands that manipulate objects (in
712 the repository, index, and working tree), commands that interrogate and
713 compare objects, and commands that move objects and references between
714 repositories.
717 Manipulation commands
718 ~~~~~~~~~~~~~~~~~~~~~
720 include::cmds-plumbingmanipulators.txt[]
723 Interrogation commands
724 ~~~~~~~~~~~~~~~~~~~~~~
726 include::cmds-plumbinginterrogators.txt[]
728 In general, the interrogate commands do not touch the files in
729 the working tree.
732 Synching repositories
733 ~~~~~~~~~~~~~~~~~~~~~
735 include::cmds-synchingrepositories.txt[]
737 The following are helper commands used by the above; end users
738 typically do not use them directly.
740 include::cmds-synchelpers.txt[]
743 Internal helper commands
744 ~~~~~~~~~~~~~~~~~~~~~~~~
746 These are internal helper commands used by other commands; end
747 users typically do not use them directly.
749 include::cmds-purehelpers.txt[]
752 Configuration Mechanism
753 -----------------------
755 Git uses a simple text format to store customizations that are per
756 repository and are per user.  Such a configuration file may look
757 like this:
759 ------------
761 # A '#' or ';' character indicates a comment.
764 ; core variables
765 [core]
766         ; Don't trust file modes
767         filemode = false
769 ; user identity
770 [user]
771         name = "Junio C Hamano"
772         email = "gitster@pobox.com"
774 ------------
776 Various commands read from the configuration file and adjust
777 their operation accordingly.  See linkgit:git-config[1] for a
778 list and more details about the configuration mechanism.
781 Identifier Terminology
782 ----------------------
783 <object>::
784         Indicates the object name for any type of object.
786 <blob>::
787         Indicates a blob object name.
789 <tree>::
790         Indicates a tree object name.
792 <commit>::
793         Indicates a commit object name.
795 <tree-ish>::
796         Indicates a tree, commit or tag object name.  A
797         command that takes a <tree-ish> argument ultimately wants to
798         operate on a <tree> object but automatically dereferences
799         <commit> and <tag> objects that point at a <tree>.
801 <commit-ish>::
802         Indicates a commit or tag object name.  A
803         command that takes a <commit-ish> argument ultimately wants to
804         operate on a <commit> object but automatically dereferences
805         <tag> objects that point at a <commit>.
807 <type>::
808         Indicates that an object type is required.
809         Currently one of: `blob`, `tree`, `commit`, or `tag`.
811 <file>::
812         Indicates a filename - almost always relative to the
813         root of the tree structure `GIT_INDEX_FILE` describes.
815 Symbolic Identifiers
816 --------------------
817 Any Git command accepting any <object> can also use the following
818 symbolic notation:
820 HEAD::
821         indicates the head of the current branch.
823 <tag>::
824         a valid tag 'name'
825         (i.e. a `refs/tags/<tag>` reference).
827 <head>::
828         a valid head 'name'
829         (i.e. a `refs/heads/<head>` reference).
831 For a more complete list of ways to spell object names, see
832 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
835 File/Directory Structure
836 ------------------------
838 Please see the linkgit:gitrepository-layout[5] document.
840 Read linkgit:githooks[5] for more details about each hook.
842 Higher level SCMs may provide and manage additional information in the
843 `$GIT_DIR`.
846 Terminology
847 -----------
848 Please see linkgit:gitglossary[7].
851 Environment Variables
852 ---------------------
853 Various Git commands use the following environment variables:
855 The Git Repository
856 ~~~~~~~~~~~~~~~~~~
857 These environment variables apply to 'all' core Git commands. Nb: it
858 is worth noting that they may be used/overridden by SCMS sitting above
859 Git so take care if using a foreign front-end.
861 `GIT_INDEX_FILE`::
862         This environment allows the specification of an alternate
863         index file. If not specified, the default of `$GIT_DIR/index`
864         is used.
866 `GIT_INDEX_VERSION`::
867         This environment variable allows the specification of an index
868         version for new repositories.  It won't affect existing index
869         files.  By default index file version 2 or 3 is used. See
870         linkgit:git-update-index[1] for more information.
872 `GIT_OBJECT_DIRECTORY`::
873         If the object storage directory is specified via this
874         environment variable then the sha1 directories are created
875         underneath - otherwise the default `$GIT_DIR/objects`
876         directory is used.
878 `GIT_ALTERNATE_OBJECT_DIRECTORIES`::
879         Due to the immutable nature of Git objects, old objects can be
880         archived into shared, read-only directories. This variable
881         specifies a ":" separated (on Windows ";" separated) list
882         of Git object directories which can be used to search for Git
883         objects. New objects will not be written to these directories.
885         Entries that begin with `"` (double-quote) will be interpreted
886         as C-style quoted paths, removing leading and trailing
887         double-quotes and respecting backslash escapes. E.g., the value
888         `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
889         `path-with-"-and-:-in-it` and `vanilla-path`.
891 `GIT_DIR`::
892         If the `GIT_DIR` environment variable is set then it
893         specifies a path to use instead of the default `.git`
894         for the base of the repository.
895         The `--git-dir` command-line option also sets this value.
897 `GIT_WORK_TREE`::
898         Set the path to the root of the working tree.
899         This can also be controlled by the `--work-tree` command-line
900         option and the core.worktree configuration variable.
902 `GIT_NAMESPACE`::
903         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
904         The `--namespace` command-line option also sets this value.
906 `GIT_CEILING_DIRECTORIES`::
907         This should be a colon-separated list of absolute paths.  If
908         set, it is a list of directories that Git should not chdir up
909         into while looking for a repository directory (useful for
910         excluding slow-loading network directories).  It will not
911         exclude the current working directory or a GIT_DIR set on the
912         command line or in the environment.  Normally, Git has to read
913         the entries in this list and resolve any symlink that
914         might be present in order to compare them with the current
915         directory.  However, if even this access is slow, you
916         can add an empty entry to the list to tell Git that the
917         subsequent entries are not symlinks and needn't be resolved;
918         e.g.,
919         `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
921 `GIT_DISCOVERY_ACROSS_FILESYSTEM`::
922         When run in a directory that does not have ".git" repository
923         directory, Git tries to find such a directory in the parent
924         directories to find the top of the working tree, but by default it
925         does not cross filesystem boundaries.  This environment variable
926         can be set to true to tell Git not to stop at filesystem
927         boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
928         an explicit repository directory set via `GIT_DIR` or on the
929         command line.
931 `GIT_COMMON_DIR`::
932         If this variable is set to a path, non-worktree files that are
933         normally in $GIT_DIR will be taken from this path
934         instead. Worktree-specific files such as HEAD or index are
935         taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
936         linkgit:git-worktree[1] for
937         details. This variable has lower precedence than other path
938         variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
940 Git Commits
941 ~~~~~~~~~~~
942 `GIT_AUTHOR_NAME`::
943 `GIT_AUTHOR_EMAIL`::
944 `GIT_AUTHOR_DATE`::
945 `GIT_COMMITTER_NAME`::
946 `GIT_COMMITTER_EMAIL`::
947 `GIT_COMMITTER_DATE`::
948 'EMAIL'::
949         see linkgit:git-commit-tree[1]
951 Git Diffs
952 ~~~~~~~~~
953 `GIT_DIFF_OPTS`::
954         Only valid setting is "--unified=??" or "-u??" to set the
955         number of context lines shown when a unified diff is created.
956         This takes precedence over any "-U" or "--unified" option
957         value passed on the Git diff command line.
959 `GIT_EXTERNAL_DIFF`::
960         When the environment variable `GIT_EXTERNAL_DIFF` is set, the
961         program named by it is called, instead of the diff invocation
962         described above.  For a path that is added, removed, or modified,
963         `GIT_EXTERNAL_DIFF` is called with 7 parameters:
965         path old-file old-hex old-mode new-file new-hex new-mode
967 where:
969         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
970                          contents of <old|new>,
971         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
972         <old|new>-mode:: are the octal representation of the file modes.
974 The file parameters can point at the user's working file
975 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
976 when a new file is added), or a temporary file (e.g. `old-file` in the
977 index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
978 temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
980 For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
981 parameter, <path>.
983 For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
984 `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
986 `GIT_DIFF_PATH_COUNTER`::
987         A 1-based counter incremented by one for every path.
989 `GIT_DIFF_PATH_TOTAL`::
990         The total number of paths.
992 other
993 ~~~~~
994 `GIT_MERGE_VERBOSITY`::
995         A number controlling the amount of output shown by
996         the recursive merge strategy.  Overrides merge.verbosity.
997         See linkgit:git-merge[1]
999 `GIT_PAGER`::
1000         This environment variable overrides `$PAGER`. If it is set
1001         to an empty string or to the value "cat", Git will not launch
1002         a pager.  See also the `core.pager` option in
1003         linkgit:git-config[1].
1005 `GIT_EDITOR`::
1006         This environment variable overrides `$EDITOR` and `$VISUAL`.
1007         It is used by several Git commands when, on interactive mode,
1008         an editor is to be launched. See also linkgit:git-var[1]
1009         and the `core.editor` option in linkgit:git-config[1].
1011 `GIT_SSH`::
1012 `GIT_SSH_COMMAND`::
1013         If either of these environment variables is set then 'git fetch'
1014         and 'git push' will use the specified command instead of 'ssh'
1015         when they need to connect to a remote system.
1016         The command will be given exactly two or four arguments: the
1017         'username@host' (or just 'host') from the URL and the shell
1018         command to execute on that remote system, optionally preceded by
1019         `-p` (literally) and the 'port' from the URL when it specifies
1020         something other than the default SSH port.
1022 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
1023 by the shell, which allows additional arguments to be included.
1024 `$GIT_SSH` on the other hand must be just the path to a program
1025 (which can be a wrapper shell script, if additional arguments are
1026 needed).
1028 Usually it is easier to configure any desired options through your
1029 personal `.ssh/config` file.  Please consult your ssh documentation
1030 for further details.
1032 `GIT_ASKPASS`::
1033         If this environment variable is set, then Git commands which need to
1034         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
1035         will call this program with a suitable prompt as command-line argument
1036         and read the password from its STDOUT. See also the `core.askPass`
1037         option in linkgit:git-config[1].
1039 `GIT_TERMINAL_PROMPT`::
1040         If this environment variable is set to `0`, git will not prompt
1041         on the terminal (e.g., when asking for HTTP authentication).
1043 `GIT_CONFIG_NOSYSTEM`::
1044         Whether to skip reading settings from the system-wide
1045         `$(prefix)/etc/gitconfig` file.  This environment variable can
1046         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
1047         predictable environment for a picky script, or you can set it
1048         temporarily to avoid using a buggy `/etc/gitconfig` file while
1049         waiting for someone with sufficient permissions to fix it.
1051 `GIT_FLUSH`::
1052         If this environment variable is set to "1", then commands such
1053         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1054         'git check-attr' and 'git check-ignore' will
1055         force a flush of the output stream after each record have been
1056         flushed. If this
1057         variable is set to "0", the output of these commands will be done
1058         using completely buffered I/O.   If this environment variable is
1059         not set, Git will choose buffered or record-oriented flushing
1060         based on whether stdout appears to be redirected to a file or not.
1062 `GIT_TRACE`::
1063         Enables general trace messages, e.g. alias expansion, built-in
1064         command execution and external command execution.
1066 If this variable is set to "1", "2" or "true" (comparison
1067 is case insensitive), trace messages will be printed to
1068 stderr.
1070 If the variable is set to an integer value greater than 2
1071 and lower than 10 (strictly) then Git will interpret this
1072 value as an open file descriptor and will try to write the
1073 trace messages into this file descriptor.
1075 Alternatively, if the variable is set to an absolute path
1076 (starting with a '/' character), Git will interpret this
1077 as a file path and will try to write the trace messages
1078 into it.
1080 Unsetting the variable, or setting it to empty, "0" or
1081 "false" (case insensitive) disables trace messages.
1083 `GIT_TRACE_PACK_ACCESS`::
1084         Enables trace messages for all accesses to any packs. For each
1085         access, the pack file name and an offset in the pack is
1086         recorded. This may be helpful for troubleshooting some
1087         pack-related performance problems.
1088         See `GIT_TRACE` for available trace output options.
1090 `GIT_TRACE_PACKET`::
1091         Enables trace messages for all packets coming in or out of a
1092         given program. This can help with debugging object negotiation
1093         or other protocol issues. Tracing is turned off at a packet
1094         starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1095         See `GIT_TRACE` for available trace output options.
1097 `GIT_TRACE_PACKFILE`::
1098         Enables tracing of packfiles sent or received by a
1099         given program. Unlike other trace output, this trace is
1100         verbatim: no headers, and no quoting of binary data. You almost
1101         certainly want to direct into a file (e.g.,
1102         `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1103         the terminal or mixing it with other trace output.
1105 Note that this is currently only implemented for the client side
1106 of clones and fetches.
1108 `GIT_TRACE_PERFORMANCE`::
1109         Enables performance related trace messages, e.g. total execution
1110         time of each Git command.
1111         See `GIT_TRACE` for available trace output options.
1113 `GIT_TRACE_SETUP`::
1114         Enables trace messages printing the .git, working tree and current
1115         working directory after Git has completed its setup phase.
1116         See `GIT_TRACE` for available trace output options.
1118 `GIT_TRACE_SHALLOW`::
1119         Enables trace messages that can help debugging fetching /
1120         cloning of shallow repositories.
1121         See `GIT_TRACE` for available trace output options.
1123 `GIT_TRACE_CURL`::
1124         Enables a curl full trace dump of all incoming and outgoing data,
1125         including descriptive information, of the git transport protocol.
1126         This is similar to doing curl `--trace-ascii` on the command line.
1127         This option overrides setting the `GIT_CURL_VERBOSE` environment
1128         variable.
1129         See `GIT_TRACE` for available trace output options.
1131 `GIT_LITERAL_PATHSPECS`::
1132         Setting this variable to `1` will cause Git to treat all
1133         pathspecs literally, rather than as glob patterns. For example,
1134         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1135         for commits that touch the path `*.c`, not any paths that the
1136         glob `*.c` matches. You might want this if you are feeding
1137         literal paths to Git (e.g., paths previously given to you by
1138         `git ls-tree`, `--raw` diff output, etc).
1140 `GIT_GLOB_PATHSPECS`::
1141         Setting this variable to `1` will cause Git to treat all
1142         pathspecs as glob patterns (aka "glob" magic).
1144 `GIT_NOGLOB_PATHSPECS`::
1145         Setting this variable to `1` will cause Git to treat all
1146         pathspecs as literal (aka "literal" magic).
1148 `GIT_ICASE_PATHSPECS`::
1149         Setting this variable to `1` will cause Git to treat all
1150         pathspecs as case-insensitive.
1152 `GIT_REFLOG_ACTION`::
1153         When a ref is updated, reflog entries are created to keep
1154         track of the reason why the ref was updated (which is
1155         typically the name of the high-level command that updated
1156         the ref), in addition to the old and new values of the ref.
1157         A scripted Porcelain command can use set_reflog_action
1158         helper function in `git-sh-setup` to set its name to this
1159         variable when it is invoked as the top level command by the
1160         end user, to be recorded in the body of the reflog.
1162 `GIT_REF_PARANOIA`::
1163         If set to `1`, include broken or badly named refs when iterating
1164         over lists of refs. In a normal, non-corrupted repository, this
1165         does nothing. However, enabling it may help git to detect and
1166         abort some operations in the presence of broken refs. Git sets
1167         this variable automatically when performing destructive
1168         operations like linkgit:git-prune[1]. You should not need to set
1169         it yourself unless you want to be paranoid about making sure
1170         an operation has touched every ref (e.g., because you are
1171         cloning a repository to make a backup).
1173 `GIT_ALLOW_PROTOCOL`::
1174         If set, provide a colon-separated list of protocols which are
1175         allowed to be used with fetch/push/clone. This is useful to
1176         restrict recursive submodule initialization from an untrusted
1177         repository. Any protocol not mentioned will be disallowed (i.e.,
1178         this is a whitelist, not a blacklist). If the variable is not
1179         set at all, all protocols are enabled.  The protocol names
1180         currently used by git are:
1182           - `file`: any local file-based path (including `file://` URLs,
1183             or local paths)
1185           - `git`: the anonymous git protocol over a direct TCP
1186             connection (or proxy, if configured)
1188           - `ssh`: git over ssh (including `host:path` syntax,
1189             `ssh://`, etc).
1191           - `http`: git over http, both "smart http" and "dumb http".
1192             Note that this does _not_ include `https`; if you want both,
1193             you should specify both as `http:https`.
1195           - any external helpers are named by their protocol (e.g., use
1196             `hg` to allow the `git-remote-hg` helper)
1199 Discussion[[Discussion]]
1200 ------------------------
1202 More detail on the following is available from the
1203 link:user-manual.html#git-concepts[Git concepts chapter of the
1204 user-manual] and linkgit:gitcore-tutorial[7].
1206 A Git project normally consists of a working directory with a ".git"
1207 subdirectory at the top level.  The .git directory contains, among other
1208 things, a compressed object database representing the complete history
1209 of the project, an "index" file which links that history to the current
1210 contents of the working tree, and named pointers into that history such
1211 as tags and branch heads.
1213 The object database contains objects of three main types: blobs, which
1214 hold file data; trees, which point to blobs and other trees to build up
1215 directory hierarchies; and commits, which each reference a single tree
1216 and some number of parent commits.
1218 The commit, equivalent to what other systems call a "changeset" or
1219 "version", represents a step in the project's history, and each parent
1220 represents an immediately preceding step.  Commits with more than one
1221 parent represent merges of independent lines of development.
1223 All objects are named by the SHA-1 hash of their contents, normally
1224 written as a string of 40 hex digits.  Such names are globally unique.
1225 The entire history leading up to a commit can be vouched for by signing
1226 just that commit.  A fourth object type, the tag, is provided for this
1227 purpose.
1229 When first created, objects are stored in individual files, but for
1230 efficiency may later be compressed together into "pack files".
1232 Named pointers called refs mark interesting points in history.  A ref
1233 may contain the SHA-1 name of an object or the name of another ref.  Refs
1234 with names beginning `ref/head/` contain the SHA-1 name of the most
1235 recent commit (or "head") of a branch under development.  SHA-1 names of
1236 tags of interest are stored under `ref/tags/`.  A special ref named
1237 `HEAD` contains the name of the currently checked-out branch.
1239 The index file is initialized with a list of all paths and, for each
1240 path, a blob object and a set of attributes.  The blob object represents
1241 the contents of the file as of the head of the current branch.  The
1242 attributes (last modified time, size, etc.) are taken from the
1243 corresponding file in the working tree.  Subsequent changes to the
1244 working tree can be found by comparing these attributes.  The index may
1245 be updated with new content, and new commits may be created from the
1246 content stored in the index.
1248 The index is also capable of storing multiple entries (called "stages")
1249 for a given pathname.  These stages are used to hold the various
1250 unmerged version of a file when a merge is in progress.
1252 FURTHER DOCUMENTATION
1253 ---------------------
1255 See the references in the "description" section to get started
1256 using Git.  The following is probably more detail than necessary
1257 for a first-time user.
1259 The link:user-manual.html#git-concepts[Git concepts chapter of the
1260 user-manual] and linkgit:gitcore-tutorial[7] both provide
1261 introductions to the underlying Git architecture.
1263 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1265 See also the link:howto-index.html[howto] documents for some useful
1266 examples.
1268 The internals are documented in the
1269 link:technical/api-index.html[Git API documentation].
1271 Users migrating from CVS may also want to
1272 read linkgit:gitcvs-migration[7].
1275 Authors
1276 -------
1277 Git was started by Linus Torvalds, and is currently maintained by Junio
1278 C Hamano. Numerous contributions have come from the Git mailing list
1279 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1280 gives you a more complete list of contributors.
1282 If you have a clone of git.git itself, the
1283 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1284 the authors for specific parts of the project.
1286 Reporting Bugs
1287 --------------
1289 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1290 development and maintenance is primarily done.  You do not have to be
1291 subscribed to the list to send a message there.
1293 SEE ALSO
1294 --------
1295 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1296 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1297 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1298 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1299 linkgit:gitworkflows[7]
1303 Part of the linkgit:git[1] suite