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