]>
Commit | Line | Data |
---|---|---|
7984eabe | 1 | git(7) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
cb22bc44 | 11 | 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS] |
2cf565c5 DG |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
23091e95 BF |
15 | Git is a fast, scalable, distributed revision control system with an |
16 | unusually rich command set that provides both high-level operations | |
17 | and full access to internals. | |
18 | ||
19 | See this link:tutorial.html[tutorial] to get started, then see | |
20 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and | |
21 | "man git-commandname" for documentation of each command. CVS users may | |
22 | also want to read link:cvs-migration.html[CVS migration]. | |
cb22bc44 AE |
23 | |
24 | OPTIONS | |
25 | ------- | |
26 | --version:: | |
a87cd02c | 27 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
28 | |
29 | --help:: | |
a87cd02c FK |
30 | Prints the synopsis and a list of the most commonly used |
31 | commands. If a git command is named this option will bring up | |
32 | the man-page for that command. If the option '--all' or '-a' is | |
33 | given then all available commands are printed. | |
cb22bc44 AE |
34 | |
35 | --exec-path:: | |
a87cd02c | 36 | Path to wherever your core git programs are installed. |
cb22bc44 AE |
37 | This can also be controlled by setting the GIT_EXEC_PATH |
38 | environment variable. If no path is given 'git' will print | |
39 | the current setting and then exit. | |
40 | ||
9755afbd | 41 | |
23091e95 BF |
42 | FURTHER DOCUMENTATION |
43 | --------------------- | |
9755afbd | 44 | |
23091e95 BF |
45 | See the references above to get started using git. The following is |
46 | probably more detail than necessary for a first-time user. | |
8db9307c | 47 | |
23091e95 BF |
48 | The <<Discussion,Discussion>> section below and the |
49 | link:core-tutorial.html[Core tutorial] both provide introductions to the | |
50 | underlying git architecture. | |
e6fc2346 | 51 | |
23091e95 BF |
52 | See also the link:howto-index.html[howto] documents for some useful |
53 | examples. | |
9755afbd | 54 | |
23091e95 BF |
55 | GIT COMMANDS |
56 | ------------ | |
9755afbd | 57 | |
23091e95 BF |
58 | We divide git into high level ("porcelain") commands and low level |
59 | ("plumbing") commands. | |
8b15e2fb | 60 | |
23091e95 BF |
61 | Low-level commands (plumbing) |
62 | ----------------------------- | |
e6fc2346 | 63 | |
23091e95 BF |
64 | Although git includes its |
65 | own porcelain layer, its low-level commands are sufficient to support | |
66 | development of alternative porcelains. Developers of such porcelains | |
67 | might start by reading about gitlink:git-update-index[1] and | |
68 | gitlink:git-read-tree[1]. | |
2cf565c5 | 69 | |
23091e95 BF |
70 | We divide the low-level commands into commands that manipulate objects (in |
71 | the repository, index, and working tree), commands that interrogate and | |
72 | compare objects, and commands that move objects and references between | |
73 | repositories. | |
204ee6a9 | 74 | |
2cf565c5 DG |
75 | Manipulation commands |
76 | ~~~~~~~~~~~~~~~~~~~~~ | |
a7154e91 | 77 | gitlink:git-apply[1]:: |
f85a4191 JH |
78 | Reads a "diff -up1" or git generated patch file and |
79 | applies it to the working tree. | |
80 | ||
a7154e91 | 81 | gitlink:git-checkout-index[1]:: |
2fa090b6 | 82 | Copy files from the index to the working tree. |
2cf565c5 | 83 | |
a7154e91 | 84 | gitlink:git-commit-tree[1]:: |
2fa090b6 | 85 | Creates a new commit object. |
2cf565c5 | 86 | |
a7154e91 | 87 | gitlink:git-hash-object[1]:: |
f85a4191 JH |
88 | Computes the object ID from a file. |
89 | ||
a52e4ef8 | 90 | gitlink:git-index-pack[1]:: |
2fa090b6 | 91 | Build pack idx file for an existing packed archive. |
9cf6d335 | 92 | |
a7154e91 | 93 | gitlink:git-init-db[1]:: |
2fa090b6 JH |
94 | Creates an empty git object database, or reinitialize an |
95 | existing one. | |
2cf565c5 | 96 | |
a7154e91 | 97 | gitlink:git-merge-index[1]:: |
2fa090b6 | 98 | Runs a merge for files needing merging. |
2cf565c5 | 99 | |
a7154e91 | 100 | gitlink:git-mktag[1]:: |
2fa090b6 | 101 | Creates a tag object. |
2cf565c5 | 102 | |
c16e30c0 JH |
103 | gitlink:git-mktree[1]:: |
104 | Build a tree-object from ls-tree formatted text. | |
105 | ||
a7154e91 | 106 | gitlink:git-pack-objects[1]:: |
f85a4191 JH |
107 | Creates a packed archive of objects. |
108 | ||
a7154e91 | 109 | gitlink:git-prune-packed[1]:: |
f85a4191 JH |
110 | Remove extra objects that are already in pack files. |
111 | ||
a7154e91 | 112 | gitlink:git-read-tree[1]:: |
2fa090b6 | 113 | Reads tree information into the index. |
2cf565c5 | 114 | |
ee72aeaf JS |
115 | gitlink:git-repo-config[1]:: |
116 | Get and set options in .git/config. | |
117 | ||
a7154e91 | 118 | gitlink:git-unpack-objects[1]:: |
f85a4191 JH |
119 | Unpacks objects out of a packed archive. |
120 | ||
a7154e91 | 121 | gitlink:git-update-index[1]:: |
2fa090b6 | 122 | Registers files in the working tree to the index. |
2cf565c5 | 123 | |
a7154e91 | 124 | gitlink:git-write-tree[1]:: |
2fa090b6 | 125 | Creates a tree from the index. |
2cf565c5 | 126 | |
e31bb3bb | 127 | |
2cf565c5 DG |
128 | Interrogation commands |
129 | ~~~~~~~~~~~~~~~~~~~~~~ | |
f85a4191 | 130 | |
a7154e91 | 131 | gitlink:git-cat-file[1]:: |
2fa090b6 | 132 | Provide content or type/size information for repository objects. |
2cf565c5 | 133 | |
c06818e2 JH |
134 | gitlink:git-describe[1]:: |
135 | Show the most recent tag that is reachable from a commit. | |
136 | ||
a7154e91 | 137 | gitlink:git-diff-index[1]:: |
2fa090b6 | 138 | Compares content and mode of blobs between the index and repository. |
2cf565c5 | 139 | |
a7154e91 | 140 | gitlink:git-diff-files[1]:: |
2fa090b6 | 141 | Compares files in the working tree and the index. |
2cf565c5 | 142 | |
a7154e91 | 143 | gitlink:git-diff-stages[1]:: |
2fa090b6 | 144 | Compares two "merge stages" in the index. |
83db04ff | 145 | |
a7154e91 | 146 | gitlink:git-diff-tree[1]:: |
2fa090b6 | 147 | Compares the content and mode of blobs found via two tree objects. |
f85a4191 | 148 | |
a7154e91 | 149 | gitlink:git-fsck-objects[1]:: |
2fa090b6 | 150 | Verifies the connectivity and validity of the objects in the database. |
2cf565c5 | 151 | |
a7154e91 | 152 | gitlink:git-ls-files[1]:: |
2fa090b6 | 153 | Information about files in the index and the working tree. |
2cf565c5 | 154 | |
a7154e91 | 155 | gitlink:git-ls-tree[1]:: |
2fa090b6 | 156 | Displays a tree object in human readable form. |
2cf565c5 | 157 | |
a7154e91 | 158 | gitlink:git-merge-base[1]:: |
2fa090b6 | 159 | Finds as good common ancestors as possible for a merge. |
2cf565c5 | 160 | |
a60d2d8f | 161 | gitlink:git-name-rev[1]:: |
2fa090b6 | 162 | Find symbolic names for given revs. |
a60d2d8f | 163 | |
76cead39 JH |
164 | gitlink:git-pack-redundant[1]:: |
165 | Find redundant pack files. | |
166 | ||
a7154e91 | 167 | gitlink:git-rev-list[1]:: |
2fa090b6 | 168 | Lists commit objects in reverse chronological order. |
2cf565c5 | 169 | |
a7154e91 | 170 | gitlink:git-show-index[1]:: |
f85a4191 JH |
171 | Displays contents of a pack idx file. |
172 | ||
a7154e91 | 173 | gitlink:git-tar-tree[1]:: |
2fa090b6 | 174 | Creates a tar archive of the files in the named tree object. |
2cf565c5 | 175 | |
a7154e91 | 176 | gitlink:git-unpack-file[1]:: |
2fa090b6 | 177 | Creates a temporary file with a blob's contents. |
2cf565c5 | 178 | |
a7154e91 | 179 | gitlink:git-var[1]:: |
2fa090b6 | 180 | Displays a git logical variable. |
aed022ab | 181 | |
a7154e91 | 182 | gitlink:git-verify-pack[1]:: |
2fa090b6 | 183 | Validates packed git archive files. |
f9253394 | 184 | |
2fa090b6 JH |
185 | In general, the interrogate commands do not touch the files in |
186 | the working tree. | |
2cf565c5 DG |
187 | |
188 | ||
0c04094b JH |
189 | Synching repositories |
190 | ~~~~~~~~~~~~~~~~~~~~~ | |
191 | ||
a7154e91 | 192 | gitlink:git-clone-pack[1]:: |
6ec311da | 193 | Clones a repository into the current repository (engine |
2fa090b6 | 194 | for ssh and local transport). |
6ec311da | 195 | |
a7154e91 | 196 | gitlink:git-fetch-pack[1]:: |
2fa090b6 JH |
197 | Updates from a remote repository (engine for ssh and |
198 | local transport). | |
f85a4191 | 199 | |
a7154e91 | 200 | gitlink:git-http-fetch[1]:: |
2fa090b6 JH |
201 | Downloads a remote git repository via HTTP by walking |
202 | commit chain. | |
204ee6a9 | 203 | |
a7154e91 | 204 | gitlink:git-local-fetch[1]:: |
2fa090b6 JH |
205 | Duplicates another git repository on a local system by |
206 | walking commit chain. | |
204ee6a9 | 207 | |
a7154e91 | 208 | gitlink:git-peek-remote[1]:: |
2fa090b6 JH |
209 | Lists references on a remote repository using |
210 | upload-pack protocol (engine for ssh and local | |
211 | transport). | |
2f2de9b4 | 212 | |
a7154e91 | 213 | gitlink:git-receive-pack[1]:: |
2f2de9b4 JH |
214 | Invoked by 'git-send-pack' to receive what is pushed to it. |
215 | ||
a7154e91 | 216 | gitlink:git-send-pack[1]:: |
f85a4191 | 217 | Pushes to a remote repository, intelligently. |
2f2de9b4 | 218 | |
76cead39 JH |
219 | gitlink:git-http-push[1]:: |
220 | Push missing objects using HTTP/DAV. | |
221 | ||
d43367af PB |
222 | gitlink:git-shell[1]:: |
223 | Restricted shell for GIT-only SSH access. | |
224 | ||
a7154e91 | 225 | gitlink:git-ssh-fetch[1]:: |
2fa090b6 JH |
226 | Pulls from a remote repository over ssh connection by |
227 | walking commit chain. | |
508e67ab | 228 | |
a7154e91 | 229 | gitlink:git-ssh-upload[1]:: |
2fa090b6 | 230 | Helper "server-side" program used by git-ssh-fetch. |
2f2de9b4 | 231 | |
a7154e91 | 232 | gitlink:git-update-server-info[1]:: |
61e3ef36 JH |
233 | Updates auxiliary information on a dumb server to help |
234 | clients discover references and packs on it. | |
235 | ||
a7154e91 | 236 | gitlink:git-upload-pack[1]:: |
f85a4191 JH |
237 | Invoked by 'git-clone-pack' and 'git-fetch-pack' to push |
238 | what are asked for. | |
239 | ||
2f2de9b4 | 240 | |
23091e95 BF |
241 | High-level commands (porcelain) |
242 | ------------------------------- | |
243 | ||
244 | We separate the porcelain commands into the main commands and some | |
245 | ancillary user utilities. | |
246 | ||
247 | Main porcelain commands | |
248 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 249 | |
a7154e91 | 250 | gitlink:git-add[1]:: |
2fa090b6 | 251 | Add paths to the index. |
905197de | 252 | |
8548ea8d PB |
253 | gitlink:git-am[1]:: |
254 | Apply patches from a mailbox, but cooler. | |
255 | ||
a7154e91 | 256 | gitlink:git-applymbox[1]:: |
2fa090b6 | 257 | Apply patches from a mailbox, original version by Linus. |
f85a4191 | 258 | |
a7154e91 | 259 | gitlink:git-bisect[1]:: |
2fa090b6 | 260 | Find the change that introduced a bug by binary search. |
f85a4191 | 261 | |
a7154e91 | 262 | gitlink:git-branch[1]:: |
905197de JH |
263 | Create and Show branches. |
264 | ||
a7154e91 | 265 | gitlink:git-checkout[1]:: |
452ce291 JH |
266 | Checkout and switch to a branch. |
267 | ||
a7154e91 | 268 | gitlink:git-cherry-pick[1]:: |
f85a4191 | 269 | Cherry-pick the effect of an existing commit. |
3f971fc4 | 270 | |
c16e30c0 JH |
271 | gitlink:git-clean[1]:: |
272 | Remove untracked files from the working tree. | |
273 | ||
a7154e91 | 274 | gitlink:git-clone[1]:: |
f85a4191 | 275 | Clones a repository into a new directory. |
3f971fc4 | 276 | |
a7154e91 | 277 | gitlink:git-commit[1]:: |
f85a4191 | 278 | Record changes to the repository. |
3f971fc4 | 279 | |
a7154e91 | 280 | gitlink:git-diff[1]:: |
2aba319a | 281 | Show changes between commits, commit and working tree, etc. |
35ef3a4c | 282 | |
a7154e91 | 283 | gitlink:git-fetch[1]:: |
62033318 JH |
284 | Download from a remote repository via various protocols. |
285 | ||
a7154e91 | 286 | gitlink:git-format-patch[1]:: |
2aba319a | 287 | Prepare patches for e-mail submission. |
35ef3a4c | 288 | |
a7154e91 | 289 | gitlink:git-grep[1]:: |
2fa090b6 | 290 | Print lines matching a pattern. |
2aba319a | 291 | |
a7154e91 | 292 | gitlink:git-log[1]:: |
f85a4191 | 293 | Shows commit logs. |
62033318 | 294 | |
a7154e91 | 295 | gitlink:git-ls-remote[1]:: |
f85a4191 | 296 | Shows references in a remote or local repository. |
ab9b3138 | 297 | |
a7154e91 | 298 | gitlink:git-merge[1]:: |
0f69be53 JH |
299 | Grand unified merge driver. |
300 | ||
8548ea8d PB |
301 | gitlink:git-mv[1]:: |
302 | Move or rename a file, a directory, or a symlink. | |
303 | ||
a7154e91 | 304 | gitlink:git-pull[1]:: |
f85a4191 JH |
305 | Fetch from and merge with a remote repository. |
306 | ||
a7154e91 | 307 | gitlink:git-push[1]:: |
ab9b3138 JH |
308 | Update remote refs along with associated objects. |
309 | ||
a7154e91 | 310 | gitlink:git-rebase[1]:: |
2fa090b6 | 311 | Rebase local commits to the updated upstream head. |
62033318 | 312 | |
a7154e91 | 313 | gitlink:git-repack[1]:: |
e31bb3bb JH |
314 | Pack unpacked objects in a repository. |
315 | ||
8389b52b JH |
316 | gitlink:git-rerere[1]:: |
317 | Reuse recorded resolution of conflicted merges. | |
318 | ||
a7154e91 | 319 | gitlink:git-reset[1]:: |
452ce291 JH |
320 | Reset current HEAD to the specified state. |
321 | ||
a7154e91 | 322 | gitlink:git-resolve[1]:: |
f85a4191 | 323 | Merge two commits. |
83db04ff | 324 | |
a7154e91 | 325 | gitlink:git-revert[1]:: |
f85a4191 JH |
326 | Revert an existing commit. |
327 | ||
c16e30c0 JH |
328 | gitlink:git-rm[1]:: |
329 | Remove files from the working tree and from the index. | |
330 | ||
a7154e91 | 331 | gitlink:git-shortlog[1]:: |
f85a4191 JH |
332 | Summarizes 'git log' output. |
333 | ||
55258b5c JL |
334 | gitlink:git-show[1]:: |
335 | Show one commit log and its diff. | |
336 | ||
a7154e91 | 337 | gitlink:git-show-branch[1]:: |
f85a4191 JH |
338 | Show branches and their commits. |
339 | ||
a7154e91 | 340 | gitlink:git-status[1]:: |
f85a4191 | 341 | Shows the working tree status. |
83db04ff | 342 | |
a7154e91 | 343 | gitlink:git-verify-tag[1]:: |
905197de JH |
344 | Check the GPG signature of tag. |
345 | ||
a7154e91 | 346 | gitlink:git-whatchanged[1]:: |
f85a4191 JH |
347 | Shows commit logs and differences they introduce. |
348 | ||
e31bb3bb | 349 | |
90933efb | 350 | Ancillary Commands |
23091e95 | 351 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
352 | Manipulators: |
353 | ||
a7154e91 | 354 | gitlink:git-applypatch[1]:: |
f85a4191 | 355 | Apply one patch extracted from an e-mail. |
905197de | 356 | |
a7154e91 | 357 | gitlink:git-archimport[1]:: |
5077fa9c JH |
358 | Import an arch repository into git. |
359 | ||
a7154e91 | 360 | gitlink:git-convert-objects[1]:: |
2fa090b6 | 361 | Converts old-style git repository. |
2f2de9b4 | 362 | |
a7154e91 | 363 | gitlink:git-cvsimport[1]:: |
f85a4191 JH |
364 | Salvage your data out of another SCM people love to hate. |
365 | ||
76cead39 JH |
366 | gitlink:git-cvsexportcommit[1]:: |
367 | Export a single commit to a CVS checkout. | |
368 | ||
c16e30c0 JH |
369 | gitlink:git-cvsserver[1]:: |
370 | A CVS server emulator for git. | |
371 | ||
0086e2c8 | 372 | gitlink:git-lost-found[1]:: |
04e7ca1a JH |
373 | Recover lost refs that luckily have not yet been pruned. |
374 | ||
a7154e91 | 375 | gitlink:git-merge-one-file[1]:: |
2fa090b6 | 376 | The standard helper program to use with `git-merge-index`. |
204ee6a9 | 377 | |
a7154e91 | 378 | gitlink:git-prune[1]:: |
2fa090b6 | 379 | Prunes all unreachable objects from the object database. |
204ee6a9 | 380 | |
a7154e91 | 381 | gitlink:git-relink[1]:: |
f85a4191 JH |
382 | Hardlink common objects in local repositories. |
383 | ||
8548ea8d PB |
384 | gitlink:git-svnimport[1]:: |
385 | Import a SVN repository into git. | |
386 | ||
a7154e91 | 387 | gitlink:git-sh-setup[1]:: |
f85a4191 JH |
388 | Common git shell script setup code. |
389 | ||
a60d2d8f | 390 | gitlink:git-symbolic-ref[1]:: |
2fa090b6 | 391 | Read and modify symbolic refs. |
a60d2d8f | 392 | |
a7154e91 | 393 | gitlink:git-tag[1]:: |
2fa090b6 | 394 | An example script to create a tag object signed with GPG. |
204ee6a9 | 395 | |
8548ea8d PB |
396 | gitlink:git-update-ref[1]:: |
397 | Update the object name stored in a ref safely. | |
398 | ||
204ee6a9 | 399 | |
90933efb | 400 | Interrogators: |
204ee6a9 | 401 | |
8548ea8d PB |
402 | gitlink:git-check-ref-format[1]:: |
403 | Make sure ref name is well formed. | |
404 | ||
a7154e91 | 405 | gitlink:git-cherry[1]:: |
f85a4191 | 406 | Find commits not merged upstream. |
905197de | 407 | |
a7154e91 | 408 | gitlink:git-count-objects[1]:: |
905197de JH |
409 | Count unpacked number of objects and their disk consumption. |
410 | ||
a7154e91 | 411 | gitlink:git-daemon[1]:: |
72e9340c | 412 | A really simple server for git repositories. |
5077fa9c | 413 | |
c16e30c0 JH |
414 | gitlink:git-fmt-merge-msg[1]:: |
415 | Produce a merge commit message. | |
416 | ||
a7154e91 | 417 | gitlink:git-get-tar-commit-id[1]:: |
5077fa9c JH |
418 | Extract commit ID from an archive created using git-tar-tree. |
419 | ||
c16e30c0 JH |
420 | gitlink:git-imap-send[1]:: |
421 | Dump a mailbox from stdin into an imap folder. | |
422 | ||
a7154e91 | 423 | gitlink:git-mailinfo[1]:: |
2fa090b6 JH |
424 | Extracts patch and authorship information from a single |
425 | e-mail message, optionally transliterating the commit | |
426 | message into utf-8. | |
f85a4191 | 427 | |
a7154e91 | 428 | gitlink:git-mailsplit[1]:: |
2fa090b6 JH |
429 | A stupid program to split UNIX mbox format mailbox into |
430 | individual pieces of e-mail. | |
f85a4191 | 431 | |
c16e30c0 JH |
432 | gitlink:git-merge-tree[1]:: |
433 | Show three-way merge without touching index. | |
434 | ||
a7154e91 | 435 | gitlink:git-patch-id[1]:: |
f85a4191 | 436 | Compute unique ID for a patch. |
204ee6a9 | 437 | |
a7154e91 | 438 | gitlink:git-parse-remote[1]:: |
2fa090b6 | 439 | Routines to help parsing `$GIT_DIR/remotes/` files. |
5077fa9c | 440 | |
a7154e91 | 441 | gitlink:git-request-pull[1]:: |
215a7ad1 | 442 | git-request-pull. |
5077fa9c | 443 | |
a7154e91 | 444 | gitlink:git-rev-parse[1]:: |
5077fa9c JH |
445 | Pick out and massage parameters. |
446 | ||
a7154e91 | 447 | gitlink:git-send-email[1]:: |
83db04ff | 448 | Send patch e-mails out of "format-patch --mbox" output. |
204ee6a9 | 449 | |
c1fe2fe4 | 450 | gitlink:git-symbolic-ref[1]:: |
8548ea8d PB |
451 | Read and modify symbolic refs. |
452 | ||
a7154e91 | 453 | gitlink:git-stripspace[1]:: |
35ef3a4c | 454 | Filter out empty lines. |
7fc9d69f | 455 | |
7fc9d69f | 456 | |
35ef3a4c JH |
457 | Commands not yet documented |
458 | --------------------------- | |
7fc9d69f | 459 | |
a7154e91 | 460 | gitlink:gitk[1]:: |
2fa090b6 | 461 | The gitk repository browser. |
7fc9d69f JH |
462 | |
463 | ||
5773c9f2 JH |
464 | Configuration Mechanism |
465 | ----------------------- | |
466 | ||
2fa090b6 | 467 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 JH |
468 | is used to hold per-repository configuration options. It is a |
469 | simple text file modelled after `.ini` format familiar to some | |
470 | people. Here is an example: | |
471 | ||
472 | ------------ | |
473 | # | |
2fa090b6 | 474 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
475 | # |
476 | ||
477 | ; core variables | |
478 | [core] | |
479 | ; Don't trust file modes | |
480 | filemode = false | |
481 | ||
482 | ; user identity | |
483 | [user] | |
484 | name = "Junio C Hamano" | |
485 | email = "junkio@twinsun.com" | |
486 | ||
487 | ------------ | |
488 | ||
489 | Various commands read from the configuration file and adjust | |
490 | their operation accordingly. | |
491 | ||
492 | ||
6c84e2e0 | 493 | Identifier Terminology |
2cf565c5 DG |
494 | ---------------------- |
495 | <object>:: | |
2fa090b6 | 496 | Indicates the object name for any type of object. |
2cf565c5 DG |
497 | |
498 | <blob>:: | |
2fa090b6 | 499 | Indicates a blob object name. |
2cf565c5 DG |
500 | |
501 | <tree>:: | |
2fa090b6 | 502 | Indicates a tree object name. |
2cf565c5 DG |
503 | |
504 | <commit>:: | |
2fa090b6 | 505 | Indicates a commit object name. |
2cf565c5 DG |
506 | |
507 | <tree-ish>:: | |
2fa090b6 | 508 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
509 | command that takes a <tree-ish> argument ultimately wants to |
510 | operate on a <tree> object but automatically dereferences | |
511 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 DG |
512 | |
513 | <type>:: | |
514 | Indicates that an object type is required. | |
2fa090b6 | 515 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
516 | |
517 | <file>:: | |
2fa090b6 JH |
518 | Indicates a filename - almost always relative to the |
519 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 520 | |
c1bdacf9 DG |
521 | Symbolic Identifiers |
522 | -------------------- | |
90933efb | 523 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 524 | symbolic notation: |
c1bdacf9 DG |
525 | |
526 | HEAD:: | |
2fa090b6 JH |
527 | indicates the head of the current branch (i.e. the |
528 | contents of `$GIT_DIR/HEAD`). | |
529 | ||
c1bdacf9 | 530 | <tag>:: |
2fa090b6 JH |
531 | a valid tag 'name' |
532 | (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). | |
533 | ||
c1bdacf9 | 534 | <head>:: |
2fa090b6 JH |
535 | a valid head 'name' |
536 | (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). | |
537 | ||
c1bdacf9 DG |
538 | |
539 | File/Directory Structure | |
540 | ------------------------ | |
c1bdacf9 | 541 | |
a1d4aa74 | 542 | Please see link:repository-layout.html[repository layout] document. |
c1bdacf9 | 543 | |
6250ad1e JL |
544 | Read link:hooks.html[hooks] for more details about each hook. |
545 | ||
c1bdacf9 | 546 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 547 | `$GIT_DIR`. |
c1bdacf9 | 548 | |
a1d4aa74 | 549 | |
2cf565c5 DG |
550 | Terminology |
551 | ----------- | |
1bff6490 | 552 | Please see link:glossary.html[glossary] document. |
2cf565c5 DG |
553 | |
554 | ||
555 | Environment Variables | |
556 | --------------------- | |
557 | Various git commands use the following environment variables: | |
558 | ||
c1bdacf9 DG |
559 | The git Repository |
560 | ~~~~~~~~~~~~~~~~~~ | |
561 | These environment variables apply to 'all' core git commands. Nb: it | |
562 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 563 | git so take care if using Cogito etc. |
c1bdacf9 DG |
564 | |
565 | 'GIT_INDEX_FILE':: | |
566 | This environment allows the specification of an alternate | |
5f3aa197 LS |
567 | index file. If not specified, the default of `$GIT_DIR/index` |
568 | is used. | |
c1bdacf9 DG |
569 | |
570 | 'GIT_OBJECT_DIRECTORY':: | |
571 | If the object storage directory is specified via this | |
572 | environment variable then the sha1 directories are created | |
573 | underneath - otherwise the default `$GIT_DIR/objects` | |
574 | directory is used. | |
575 | ||
576 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
577 | Due to the immutable nature of git objects, old objects can be | |
578 | archived into shared, read-only directories. This variable | |
90933efb | 579 | specifies a ":" separated list of git object directories which |
c1bdacf9 DG |
580 | can be used to search for git objects. New objects will not be |
581 | written to these directories. | |
582 | ||
583 | 'GIT_DIR':: | |
2fa090b6 JH |
584 | If the 'GIT_DIR' environment variable is set then it |
585 | specifies a path to use instead of the default `.git` | |
586 | for the base of the repository. | |
c1bdacf9 DG |
587 | |
588 | git Commits | |
589 | ~~~~~~~~~~~ | |
590 | 'GIT_AUTHOR_NAME':: | |
591 | 'GIT_AUTHOR_EMAIL':: | |
592 | 'GIT_AUTHOR_DATE':: | |
593 | 'GIT_COMMITTER_NAME':: | |
594 | 'GIT_COMMITTER_EMAIL':: | |
a7154e91 | 595 | see gitlink:git-commit-tree[1] |
c1bdacf9 DG |
596 | |
597 | git Diffs | |
598 | ~~~~~~~~~ | |
d81ed1b5 JH |
599 | 'GIT_DIFF_OPTS':: |
600 | 'GIT_EXTERNAL_DIFF':: | |
c1bdacf9 | 601 | see the "generating patches" section in : |
a7154e91 SV |
602 | gitlink:git-diff-index[1]; |
603 | gitlink:git-diff-files[1]; | |
604 | gitlink:git-diff-tree[1] | |
2cf565c5 | 605 | |
8db9307c JH |
606 | Discussion[[Discussion]] |
607 | ------------------------ | |
941c9449 | 608 | include::README[] |
6c84e2e0 | 609 | |
cb22bc44 AE |
610 | Authors |
611 | ------- | |
9755afbd JH |
612 | * git's founding father is Linus Torvalds <torvalds@osdl.org>. |
613 | * The current git nurse is Junio C Hamano <junkio@cox.net>. | |
614 | * The git potty was written by Andres Ericsson <ae@op5.se>. | |
615 | * General upbringing is handled by the git-list <git@vger.kernel.org>. | |
2cf565c5 DG |
616 | |
617 | Documentation | |
618 | -------------- | |
9755afbd JH |
619 | The documentation for git suite was started by David Greaves |
620 | <david@dgreaves.com>, and later enhanced greatly by the | |
621 | contributors on the git-list <git@vger.kernel.org>. | |
2cf565c5 DG |
622 | |
623 | GIT | |
624 | --- | |
a7154e91 | 625 | Part of the gitlink:git[7] suite |
2cf565c5 | 626 |