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