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