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