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