git.txt 24.7 KB
Newer Older
1
git(1)
2 3 4 5 6 7 8 9 10
======

NAME
----
git - the stupid content tracker


SYNOPSIS
--------
11
[verse]
12
'git' [--version] [--exec-path[=<path>]] [--html-path]
13
    [-p|--paginate|--no-pager] [--no-replace-objects]
14 15 16
    [--bare] [--git-dir=<path>] [--work-tree=<path>]
    [-c <name>=<value>]
    [--help] <command> [<args>]
17 18 19

DESCRIPTION
-----------
20 21 22 23
Git is a fast, scalable, distributed revision control system with an
unusually rich command set that provides both high-level operations
and full access to internals.

24
See linkgit:gittutorial[7] to get started, then see
25 26
link:everyday.html[Everyday Git] for a useful minimum set of commands, and
"man git-commandname" for documentation of each command.  CVS users may
27 28
also want to read linkgit:gitcvs-migration[7].  See
the link:user-manual.html[Git User's Manual] for a more in-depth
29
introduction.
30

31
The '<command>' is either a name of a Git command (see below) or an alias
32
as defined in the configuration file (see linkgit:git-config[1]).
P
Petr Baudis 已提交
33

34 35 36 37
Formatted and hyperlinked version of the latest git
documentation can be viewed at
`http://www.kernel.org/pub/software/scm/git/docs/`.

38 39 40 41
ifdef::stalenotes[]
[NOTE]
============

42 43 44 45
You are reading the documentation for the latest (possibly
unreleased) version of git, that is available from 'master'
branch of the `git.git` repository.
Documentation for older releases are available here:
46

J
Junio C Hamano 已提交
47
* link:v1.7.5.1/git.html[documentation for release 1.7.5.1]
J
Junio C Hamano 已提交
48 49

* release notes for
J
Junio C Hamano 已提交
50
  link:RelNotes/1.7.5.1.txt[1.7.5.1],
J
Junio C Hamano 已提交
51 52
  link:RelNotes/1.7.5.txt[1.7.5].

J
Junio C Hamano 已提交
53
* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
J
Junio C Hamano 已提交
54 55

* release notes for
J
Junio C Hamano 已提交
56
  link:RelNotes/1.7.4.5.txt[1.7.4.5],
J
Junio C Hamano 已提交
57
  link:RelNotes/1.7.4.4.txt[1.7.4.4],
J
Junio C Hamano 已提交
58 59
  link:RelNotes/1.7.4.3.txt[1.7.4.3],
  link:RelNotes/1.7.4.2.txt[1.7.4.2],
J
Junio C Hamano 已提交
60
  link:RelNotes/1.7.4.1.txt[1.7.4.1],
J
Junio C Hamano 已提交
61 62
  link:RelNotes/1.7.4.txt[1.7.4].

J
Junio C Hamano 已提交
63
* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
J
Junio C Hamano 已提交
64 65

* release notes for
J
Junio C Hamano 已提交
66
  link:RelNotes/1.7.3.5.txt[1.7.3.5],
J
Junio C Hamano 已提交
67
  link:RelNotes/1.7.3.4.txt[1.7.3.4],
68
  link:RelNotes/1.7.3.3.txt[1.7.3.3],
J
Junio C Hamano 已提交
69
  link:RelNotes/1.7.3.2.txt[1.7.3.2],
J
Junio C Hamano 已提交
70
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
71 72
  link:RelNotes/1.7.3.txt[1.7.3].

73
* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
J
Junio C Hamano 已提交
74 75

* release notes for
76
  link:RelNotes/1.7.2.5.txt[1.7.2.5],
77
  link:RelNotes/1.7.2.4.txt[1.7.2.4],
78 79 80 81
  link:RelNotes/1.7.2.3.txt[1.7.2.3],
  link:RelNotes/1.7.2.2.txt[1.7.2.2],
  link:RelNotes/1.7.2.1.txt[1.7.2.1],
  link:RelNotes/1.7.2.txt[1.7.2].
J
Junio C Hamano 已提交
82

83
* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
J
Junio C Hamano 已提交
84 85

* release notes for
86
  link:RelNotes/1.7.1.4.txt[1.7.1.4],
87
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
88 89 90
  link:RelNotes/1.7.1.2.txt[1.7.1.2],
  link:RelNotes/1.7.1.1.txt[1.7.1.1],
  link:RelNotes/1.7.1.txt[1.7.1].
J
Junio C Hamano 已提交
91

92
* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
J
Junio C Hamano 已提交
93 94

* release notes for
95
  link:RelNotes/1.7.0.9.txt[1.7.0.9],
96
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
97 98 99 100 101 102 103 104
  link:RelNotes/1.7.0.7.txt[1.7.0.7],
  link:RelNotes/1.7.0.6.txt[1.7.0.6],
  link:RelNotes/1.7.0.5.txt[1.7.0.5],
  link:RelNotes/1.7.0.4.txt[1.7.0.4],
  link:RelNotes/1.7.0.3.txt[1.7.0.3],
  link:RelNotes/1.7.0.2.txt[1.7.0.2],
  link:RelNotes/1.7.0.1.txt[1.7.0.1],
  link:RelNotes/1.7.0.txt[1.7.0].
J
Junio C Hamano 已提交
105

106
* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
J
Junio C Hamano 已提交
107 108

* release notes for
109
  link:RelNotes/1.6.6.3.txt[1.6.6.3],
110 111 112
  link:RelNotes/1.6.6.2.txt[1.6.6.2],
  link:RelNotes/1.6.6.1.txt[1.6.6.1],
  link:RelNotes/1.6.6.txt[1.6.6].
J
Junio C Hamano 已提交
113

114
* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
J
Junio C Hamano 已提交
115 116

* release notes for
117
  link:RelNotes/1.6.5.9.txt[1.6.5.9],
118 119 120 121 122 123 124 125 126
  link:RelNotes/1.6.5.8.txt[1.6.5.8],
  link:RelNotes/1.6.5.7.txt[1.6.5.7],
  link:RelNotes/1.6.5.6.txt[1.6.5.6],
  link:RelNotes/1.6.5.5.txt[1.6.5.5],
  link:RelNotes/1.6.5.4.txt[1.6.5.4],
  link:RelNotes/1.6.5.3.txt[1.6.5.3],
  link:RelNotes/1.6.5.2.txt[1.6.5.2],
  link:RelNotes/1.6.5.1.txt[1.6.5.1],
  link:RelNotes/1.6.5.txt[1.6.5].
J
Junio C Hamano 已提交
127

128
* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
J
Junio C Hamano 已提交
129 130

* release notes for
131
  link:RelNotes/1.6.4.5.txt[1.6.4.5],
132 133 134 135 136
  link:RelNotes/1.6.4.4.txt[1.6.4.4],
  link:RelNotes/1.6.4.3.txt[1.6.4.3],
  link:RelNotes/1.6.4.2.txt[1.6.4.2],
  link:RelNotes/1.6.4.1.txt[1.6.4.1],
  link:RelNotes/1.6.4.txt[1.6.4].
J
Junio C Hamano 已提交
137

J
Junio C Hamano 已提交
138
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
139 140

* release notes for
141 142 143 144 145
  link:RelNotes/1.6.3.4.txt[1.6.3.4],
  link:RelNotes/1.6.3.3.txt[1.6.3.3],
  link:RelNotes/1.6.3.2.txt[1.6.3.2],
  link:RelNotes/1.6.3.1.txt[1.6.3.1],
  link:RelNotes/1.6.3.txt[1.6.3].
J
Junio C Hamano 已提交
146 147

* release notes for
148 149 150 151 152 153
  link:RelNotes/1.6.2.5.txt[1.6.2.5],
  link:RelNotes/1.6.2.4.txt[1.6.2.4],
  link:RelNotes/1.6.2.3.txt[1.6.2.3],
  link:RelNotes/1.6.2.2.txt[1.6.2.2],
  link:RelNotes/1.6.2.1.txt[1.6.2.1],
  link:RelNotes/1.6.2.txt[1.6.2].
J
Junio C Hamano 已提交
154

J
Junio C Hamano 已提交
155
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
156 157

* release notes for
158 159 160 161
  link:RelNotes/1.6.1.3.txt[1.6.1.3],
  link:RelNotes/1.6.1.2.txt[1.6.1.2],
  link:RelNotes/1.6.1.1.txt[1.6.1.1],
  link:RelNotes/1.6.1.txt[1.6.1].
J
Junio C Hamano 已提交
162

163
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
164 165

* release notes for
166 167 168 169 170 171 172
  link:RelNotes/1.6.0.6.txt[1.6.0.6],
  link:RelNotes/1.6.0.5.txt[1.6.0.5],
  link:RelNotes/1.6.0.4.txt[1.6.0.4],
  link:RelNotes/1.6.0.3.txt[1.6.0.3],
  link:RelNotes/1.6.0.2.txt[1.6.0.2],
  link:RelNotes/1.6.0.1.txt[1.6.0.1],
  link:RelNotes/1.6.0.txt[1.6.0].
J
Junio C Hamano 已提交
173

174
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
175 176

* release notes for
177 178 179 180 181 182 183
  link:RelNotes/1.5.6.6.txt[1.5.6.6],
  link:RelNotes/1.5.6.5.txt[1.5.6.5],
  link:RelNotes/1.5.6.4.txt[1.5.6.4],
  link:RelNotes/1.5.6.3.txt[1.5.6.3],
  link:RelNotes/1.5.6.2.txt[1.5.6.2],
  link:RelNotes/1.5.6.1.txt[1.5.6.1],
  link:RelNotes/1.5.6.txt[1.5.6].
J
Junio C Hamano 已提交
184

185
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
186 187

* release notes for
188 189 190 191 192 193 194
  link:RelNotes/1.5.5.6.txt[1.5.5.6],
  link:RelNotes/1.5.5.5.txt[1.5.5.5],
  link:RelNotes/1.5.5.4.txt[1.5.5.4],
  link:RelNotes/1.5.5.3.txt[1.5.5.3],
  link:RelNotes/1.5.5.2.txt[1.5.5.2],
  link:RelNotes/1.5.5.1.txt[1.5.5.1],
  link:RelNotes/1.5.5.txt[1.5.5].
J
Junio C Hamano 已提交
195

196
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
197 198

* release notes for
199 200 201 202 203 204 205 206
  link:RelNotes/1.5.4.7.txt[1.5.4.7],
  link:RelNotes/1.5.4.6.txt[1.5.4.6],
  link:RelNotes/1.5.4.5.txt[1.5.4.5],
  link:RelNotes/1.5.4.4.txt[1.5.4.4],
  link:RelNotes/1.5.4.3.txt[1.5.4.3],
  link:RelNotes/1.5.4.2.txt[1.5.4.2],
  link:RelNotes/1.5.4.1.txt[1.5.4.1],
  link:RelNotes/1.5.4.txt[1.5.4].
207

J
Junio C Hamano 已提交
208
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
209 210

* release notes for
211 212 213 214 215 216 217 218 219
  link:RelNotes/1.5.3.8.txt[1.5.3.8],
  link:RelNotes/1.5.3.7.txt[1.5.3.7],
  link:RelNotes/1.5.3.6.txt[1.5.3.6],
  link:RelNotes/1.5.3.5.txt[1.5.3.5],
  link:RelNotes/1.5.3.4.txt[1.5.3.4],
  link:RelNotes/1.5.3.3.txt[1.5.3.3],
  link:RelNotes/1.5.3.2.txt[1.5.3.2],
  link:RelNotes/1.5.3.1.txt[1.5.3.1],
  link:RelNotes/1.5.3.txt[1.5.3].
220

J
Junio C Hamano 已提交
221 222
* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]

J
Junio C Hamano 已提交
223
* release notes for
224 225 226 227 228 229
  link:RelNotes/1.5.2.5.txt[1.5.2.5],
  link:RelNotes/1.5.2.4.txt[1.5.2.4],
  link:RelNotes/1.5.2.3.txt[1.5.2.3],
  link:RelNotes/1.5.2.2.txt[1.5.2.2],
  link:RelNotes/1.5.2.1.txt[1.5.2.1],
  link:RelNotes/1.5.2.txt[1.5.2].
J
Junio C Hamano 已提交
230 231 232 233

* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]

* release notes for
234 235 236 237 238 239 240
  link:RelNotes/1.5.1.6.txt[1.5.1.6],
  link:RelNotes/1.5.1.5.txt[1.5.1.5],
  link:RelNotes/1.5.1.4.txt[1.5.1.4],
  link:RelNotes/1.5.1.3.txt[1.5.1.3],
  link:RelNotes/1.5.1.2.txt[1.5.1.2],
  link:RelNotes/1.5.1.1.txt[1.5.1.1],
  link:RelNotes/1.5.1.txt[1.5.1].
241 242 243

* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]

J
Junio C Hamano 已提交
244
* release notes for
245 246 247 248 249 250 251
  link:RelNotes/1.5.0.7.txt[1.5.0.7],
  link:RelNotes/1.5.0.6.txt[1.5.0.6],
  link:RelNotes/1.5.0.5.txt[1.5.0.5],
  link:RelNotes/1.5.0.3.txt[1.5.0.3],
  link:RelNotes/1.5.0.2.txt[1.5.0.2],
  link:RelNotes/1.5.0.1.txt[1.5.0.1],
  link:RelNotes/1.5.0.txt[1.5.0].
252 253 254 255 256

* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
  link:v1.3.3/git.html[1.3.3],
  link:v1.2.6/git.html[1.2.6],
  link:v1.0.13/git.html[1.0.13].
257 258 259 260 261

============

endif::stalenotes[]

262 263 264
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
265
	Prints the git suite version that the 'git' program came from.
266 267

--help::
F
Fredrik Kuivinen 已提交
268
	Prints the synopsis and a list of the most commonly used
269 270 271
	commands. If the option '--all' or '-a' is given then all
	available commands are printed. If a git command is named this
	option will bring up the manual page for that command.
272 273
+
Other options are available to control how the manual page is
274
displayed. See linkgit:git-help[1] for more information,
275 276
because `git --help ...` is converted internally into `git
help ...`.
277

278 279 280 281 282 283
-c <name>=<value>::
	Pass a configuration parameter to the command. The value
	given will override values from configuration files.
	The <name> is expected in the same format as listed by
	'git config' (subkeys separated by dots).

284
--exec-path[=<path>]::
F
Fredrik Kuivinen 已提交
285
	Path to wherever your core git programs are installed.
286
	This can also be controlled by setting the GIT_EXEC_PATH
J
Jonathan Nieder 已提交
287
	environment variable. If no path is given, 'git' will print
288 289
	the current setting and then exit.

290 291 292 293
--html-path::
	Print the path to wherever your git HTML documentation is installed
	and exit.

294 295
-p::
--paginate::
296 297 298 299
	Pipe all output into 'less' (or if set, $PAGER) if standard
	output is a terminal.  This overrides the `pager.<cmd>`
	configuration options (see the "Configuration Mechanism" section
	below).
300

301 302 303
--no-pager::
	Do not pipe git output into a pager.

304 305
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
306 307
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
308

309
--work-tree=<path>::
310 311
	Set the path to the working tree. It can be an absolute path
	or a path relative to the current working directory.
312 313
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
314 315
	variable (see core.worktree in linkgit:git-config[1] for a
	more detailed discussion).
316

317
--bare::
318 319 320 321
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

322 323 324 325
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

326

327 328
FURTHER DOCUMENTATION
---------------------
329

330 331
See the references above to get started using git.  The following is
probably more detail than necessary for a first-time user.
J
Junio C Hamano 已提交
332

333
The link:user-manual.html#git-concepts[git concepts chapter of the
334
user-manual] and linkgit:gitcore-tutorial[7] both provide
335
introductions to the underlying git architecture.
336

337 338
See linkgit:gitworkflows[7] for an overview of recommended workflows.

339 340
See also the link:howto-index.html[howto] documents for some useful
examples.
341

342 343
The internals are documented in the
link:technical/api-index.html[GIT API documentation].
344

345 346
GIT COMMANDS
------------
347

348 349
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
350

351 352 353 354 355 356 357 358
High-level commands (porcelain)
-------------------------------

We separate the porcelain commands into the main commands and some
ancillary user utilities.

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
359

360
include::cmds-mainporcelain.txt[]
361

362
Ancillary Commands
363
~~~~~~~~~~~~~~~~~~
364 365
Manipulators:

366
include::cmds-ancillarymanipulators.txt[]
367

368
Interrogators:
369

370
include::cmds-ancillaryinterrogators.txt[]
371

372 373 374 375 376 377 378 379 380 381

Interacting with Others
~~~~~~~~~~~~~~~~~~~~~~~

These commands are to interact with foreign SCM and with other
people via patch over e-mail.

include::cmds-foreignscminterface.txt[]


382 383 384 385 386 387
Low-level commands (plumbing)
-----------------------------

Although git includes its
own porcelain layer, its low-level commands are sufficient to support
development of alternative porcelains.  Developers of such porcelains
388 389
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
390

391 392 393 394 395 396 397 398 399
The interface (input, output, set of options and the semantics)
to these low-level commands are meant to be a lot more stable
than Porcelain level commands, because these commands are
primarily for scripted use.  The interface to Porcelain commands
on the other hand are subject to change in order to improve the
end user experience.

The following description divides
the low-level commands into commands that manipulate objects (in
400 401 402 403
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

404

405 406 407
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

408
include::cmds-plumbingmanipulators.txt[]
409 410 411 412 413


Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~

414
include::cmds-plumbinginterrogators.txt[]
415 416 417 418 419 420 421 422

In general, the interrogate commands do not touch the files in
the working tree.


Synching repositories
~~~~~~~~~~~~~~~~~~~~~

423
include::cmds-synchingrepositories.txt[]
424

425
The following are helper commands used by the above; end users
426 427 428 429 430 431 432 433 434 435 436 437 438
typically do not use them directly.

include::cmds-synchelpers.txt[]


Internal helper commands
~~~~~~~~~~~~~~~~~~~~~~~~

These are internal helper commands used by other commands; end
users typically do not use them directly.

include::cmds-purehelpers.txt[]

439

J
Junio C Hamano 已提交
440 441 442
Configuration Mechanism
-----------------------

J
Junio C Hamano 已提交
443
Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
J
Junio C Hamano 已提交
444
is used to hold per-repository configuration options.  It is a
P
Pavel Roskin 已提交
445
simple text file modeled after `.ini` format familiar to some
J
Junio C Hamano 已提交
446 447 448 449
people.  Here is an example:

------------
#
J
Junio C Hamano 已提交
450
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
#

; core variables
[core]
	; Don't trust file modes
	filemode = false

; user identity
[user]
	name = "Junio C Hamano"
	email = "junkio@twinsun.com"

------------

Various commands read from the configuration file and adjust
466 467
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
468 469


470
Identifier Terminology
471 472
----------------------
<object>::
J
Junio C Hamano 已提交
473
	Indicates the object name for any type of object.
474 475

<blob>::
J
Junio C Hamano 已提交
476
	Indicates a blob object name.
477 478

<tree>::
J
Junio C Hamano 已提交
479
	Indicates a tree object name.
480 481

<commit>::
J
Junio C Hamano 已提交
482
	Indicates a commit object name.
483 484

<tree-ish>::
J
Junio C Hamano 已提交
485
	Indicates a tree, commit or tag object name.  A
486 487 488
	command that takes a <tree-ish> argument ultimately wants to
	operate on a <tree> object but automatically dereferences
	<commit> and <tag> objects that point at a <tree>.
489

490 491 492 493 494 495
<commit-ish>::
	Indicates a commit or tag object name.  A
	command that takes a <commit-ish> argument ultimately wants to
	operate on a <commit> object but automatically dereferences
	<tag> objects that point at a <commit>.

496 497
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
498
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
499 500

<file>::
J
Junio C Hamano 已提交
501 502
	Indicates a filename - almost always relative to the
	root of the tree structure `GIT_INDEX_FILE` describes.
503

504 505
Symbolic Identifiers
--------------------
506
Any git command accepting any <object> can also use the following
507
symbolic notation:
508 509

HEAD::
J
Junio C Hamano 已提交
510 511 512
	indicates the head of the current branch (i.e. the
	contents of `$GIT_DIR/HEAD`).

513
<tag>::
J
Junio C Hamano 已提交
514 515 516
	a valid tag 'name'
	(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).

517
<head>::
J
Junio C Hamano 已提交
518 519 520
	a valid head 'name'
	(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).

521
For a more complete list of ways to spell object names, see
522
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
523

524 525 526 527

File/Directory Structure
------------------------

528
Please see the linkgit:gitrepository-layout[5] document.
529

530
Read linkgit:githooks[5] for more details about each hook.
531

532
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
533
`$GIT_DIR`.
534

J
Junio C Hamano 已提交
535

536 537
Terminology
-----------
538
Please see linkgit:gitglossary[7].
539 540 541 542 543 544


Environment Variables
---------------------
Various git commands use the following environment variables:

545 546 547 548
The git Repository
~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core git commands. Nb: it
is worth noting that they may be used/overridden by SCMS sitting above
J
Junio C Hamano 已提交
549
git so take care if using Cogito etc.
550 551 552

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
553 554
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
555 556 557 558 559 560 561 562 563 564

'GIT_OBJECT_DIRECTORY'::
	If the object storage directory is specified via this
	environment variable then the sha1 directories are created
	underneath - otherwise the default `$GIT_DIR/objects`
	directory is used.

'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
	Due to the immutable nature of git objects, old objects can be
	archived into shared, read-only directories. This variable
565 566 567
	specifies a ":" separated (on Windows ";" separated) list
	of git object directories which can be used to search for git
	objects. New objects will not be written to these directories.
568 569

'GIT_DIR'::
J
Junio C Hamano 已提交
570 571 572
	If the 'GIT_DIR' environment variable is set then it
	specifies a path to use instead of the default `.git`
	for the base of the repository.
573

574 575 576 577 578 579 580
'GIT_WORK_TREE'::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
	This can also be controlled by the '--work-tree' command line
	option and the core.worktree configuration variable.

581 582 583 584 585 586 587 588
'GIT_CEILING_DIRECTORIES'::
	This should be a colon-separated list of absolute paths.
	If set, it is a list of directories that git should not chdir
	up into while looking for a repository directory.
	It will not exclude the current working directory or
	a GIT_DIR set on the command line or in the environment.
	(Useful for excluding slow-loading network directories.)

589
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
590 591 592 593
	When run in a directory that does not have ".git" repository
	directory, git tries to find such a directory in the parent
	directories to find the top of the working tree, but by default it
	does not cross filesystem boundaries.  This environment variable
594 595 596 597
	can be set to true to tell git not to stop at filesystem
	boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
	an explicit repository directory set via 'GIT_DIR' or on the
	command line.
598

599 600 601 602 603 604 605
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
606
'GIT_COMMITTER_DATE'::
607
'EMAIL'::
608
	see linkgit:git-commit-tree[1]
609 610 611

git Diffs
~~~~~~~~~
612
'GIT_DIFF_OPTS'::
613 614 615 616 617
	Only valid setting is "--unified=??" or "-u??" to set the
	number of context lines shown when a unified diff is created.
	This takes precedence over any "-U" or "--unified" option
	value passed on the git diff command line.

618
'GIT_EXTERNAL_DIFF'::
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
	When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
	program named by it is called, instead of the diff invocation
	described above.  For a path that is added, removed, or modified,
        'GIT_EXTERNAL_DIFF' is called with 7 parameters:

	path old-file old-hex old-mode new-file new-hex new-mode
+
where:

	<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
                         contents of <old|new>,
	<old|new>-hex:: are the 40-hexdigit SHA1 hashes,
	<old|new>-mode:: are the octal representation of the file modes.
+
The file parameters can point at the user's working file
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
when a new file is added), or a temporary file (e.g. `old-file` in the
index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
+
For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
parameter, <path>.
641

642 643
other
~~~~~
J
Jakub Narebski 已提交
644 645 646
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
647
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
648

649
'GIT_PAGER'::
650 651
	This environment variable overrides `$PAGER`. If it is set
	to an empty string or to the value "cat", git will not launch
652 653
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
654

655
'GIT_SSH'::
656 657
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
658
	of 'ssh' when they need to connect to a remote system.
659
	The '$GIT_SSH' command will be given exactly two arguments:
660 661 662 663 664 665 666 667 668 669 670
	the 'username@host' (or just 'host') from the URL and the
	shell command to execute on that remote system.
+
To pass options to the program that you want to list in GIT_SSH
you will need to wrap the program and options into a shell script,
then set GIT_SSH to refer to the shell script.
+
Usually it is easier to configure any desired options through your
personal `.ssh/config` file.  Please consult your ssh documentation
for further details.

671 672 673 674 675 676 677
'GIT_ASKPASS'::
	If this environment variable is set, then git commands which need to
	acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
	will call this program with a suitable prompt as command line argument
	and read the password from its STDOUT. See also the 'core.askpass'
	option in linkgit:git-config[1].

678 679
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
680 681
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
682 683 684 685 686 687
	after each commit-oriented record have been flushed.   If this
	variable is set to "0", the output of these commands will be done
	using completely buffered I/O.   If this environment variable is
	not set, git will choose buffered or record-oriented flushing
	based on whether stdout appears to be redirected to a file or not.

688
'GIT_TRACE'::
689 690
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
691 692
	stderr telling about alias expansion, built-in command
	execution and external command execution.
693 694 695 696 697 698 699 700
	If this variable is set to an integer value greater than 1
	and lower than 10 (strictly) then git will interpret this
	value as an open file descriptor and will try to write the
	trace messages into this file descriptor.
	Alternatively, if this variable is set to an absolute path
	(starting with a '/' character), git will interpret this
	as a file path and will try to write the trace messages
	into it.
701

J
Junio C Hamano 已提交
702 703
Discussion[[Discussion]]
------------------------
704 705 706

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
707
user-manual] and linkgit:gitcore-tutorial[7].
708 709 710 711 712 713 714 715 716 717

A git project normally consists of a working directory with a ".git"
subdirectory at the top level.  The .git directory contains, among other
things, a compressed object database representing the complete history
of the project, an "index" file which links that history to the current
contents of the working tree, and named pointers into that history such
as tags and branch heads.

The object database contains objects of three main types: blobs, which
hold file data; trees, which point to blobs and other trees to build up
R
Ralf Wildenhues 已提交
718
directory hierarchies; and commits, which each reference a single tree
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
and some number of parent commits.

The commit, equivalent to what other systems call a "changeset" or
"version", represents a step in the project's history, and each parent
represents an immediately preceding step.  Commits with more than one
parent represent merges of independent lines of development.

All objects are named by the SHA1 hash of their contents, normally
written as a string of 40 hex digits.  Such names are globally unique.
The entire history leading up to a commit can be vouched for by signing
just that commit.  A fourth object type, the tag, is provided for this
purpose.

When first created, objects are stored in individual files, but for
efficiency may later be compressed together into "pack files".

Named pointers called refs mark interesting points in history.  A ref
may contain the SHA1 name of an object or the name of another ref.  Refs
with names beginning `ref/head/` contain the SHA1 name of the most
R
Ralf Wildenhues 已提交
738
recent commit (or "head") of a branch under development.  SHA1 names of
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
tags of interest are stored under `ref/tags/`.  A special ref named
`HEAD` contains the name of the currently checked-out branch.

The index file is initialized with a list of all paths and, for each
path, a blob object and a set of attributes.  The blob object represents
the contents of the file as of the head of the current branch.  The
attributes (last modified time, size, etc.) are taken from the
corresponding file in the working tree.  Subsequent changes to the
working tree can be found by comparing these attributes.  The index may
be updated with new content, and new commits may be created from the
content stored in the index.

The index is also capable of storing multiple entries (called "stages")
for a given pathname.  These stages are used to hold the various
unmerged version of a file when a merge is in progress.
754

755 756
Authors
-------
757 758
Git was started by Linus Torvalds, and is currently maintained by Junio
C Hamano. Numerous contributions have come from the git mailing list
759 760 761 762
<git@vger.kernel.org>. For a more complete list of contributors, see
http://git-scm.com/about. If you have a clone of git.git itself, the
output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
the authors for specific parts of the project.
763

J
Junio C Hamano 已提交
764 765 766 767 768 769 770
Reporting Bugs
--------------

Report bugs to the Git mailing list <git@vger.kernel.org> where the
development and maintenance is primarily done.  You do not have to be
subscribed to the list to send a message there.

771 772 773
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
774
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
775
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
776 777
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
778

779 780
GIT
---
781
Part of the linkgit:git[1] suite