]>
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 | -------- | |
11 | 'git-<command>' <args> | |
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | ||
16 | This is reference information for the core git commands. | |
17 | ||
0d6a873c JH |
18 | Before reading this cover to cover, you may want to take a look |
19 | at the link:tutorial.html[tutorial] document. | |
20 | ||
8db9307c | 21 | The <<Discussion>> section below contains much useful definition and |
6c84e2e0 | 22 | clarification info - read that first. And of the commands, I suggest |
a7154e91 SV |
23 | reading gitlink:git-update-index[1] and |
24 | gitlink:git-read-tree[1] first - I wish I had! | |
2cf565c5 | 25 | |
8db9307c JH |
26 | If you are migrating from CVS, link:cvs-migration.html[cvs migration] |
27 | document may be helpful after you finish the tutorial. | |
28 | ||
e6fc2346 JH |
29 | After you get the general feel from the tutorial and this |
30 | overview page, you may want to take a look at the | |
31 | link:howto-index.html[howto] documents. | |
32 | ||
33 | ||
2cf565c5 DG |
34 | David Greaves <david@dgreaves.com> |
35 | 08/05/05 | |
36 | ||
37 | Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 to | |
38 | reflect recent changes. | |
39 | ||
40 | Commands Overview | |
41 | ----------------- | |
42 | The git commands can helpfully be split into those that manipulate | |
2f2de9b4 JH |
43 | the repository, the cache and the working fileset, those that |
44 | interrogate and compare them, and those that moves objects and | |
45 | references between repositories. | |
2cf565c5 | 46 | |
62033318 JH |
47 | In addition, git itself comes with a spartan set of porcelain |
48 | commands. They are usable but are not meant to compete with real | |
49 | Porcelains. | |
50 | ||
90933efb | 51 | There are also some ancillary programs that can be viewed as useful |
204ee6a9 DG |
52 | aids for using the core commands but which are unlikely to be used by |
53 | SCMs layered over git. | |
54 | ||
2cf565c5 DG |
55 | Manipulation commands |
56 | ~~~~~~~~~~~~~~~~~~~~~ | |
a7154e91 | 57 | gitlink:git-apply[1]:: |
f85a4191 JH |
58 | Reads a "diff -up1" or git generated patch file and |
59 | applies it to the working tree. | |
60 | ||
a7154e91 | 61 | gitlink:git-checkout-index[1]:: |
2cf565c5 | 62 | Copy files from the cache to the working directory |
215a7ad1 | 63 | Previously this command was known as git-checkout-cache. |
2cf565c5 | 64 | |
a7154e91 | 65 | gitlink:git-commit-tree[1]:: |
2cf565c5 DG |
66 | Creates a new commit object |
67 | ||
a7154e91 | 68 | gitlink:git-hash-object[1]:: |
f85a4191 JH |
69 | Computes the object ID from a file. |
70 | ||
9cf6d335 SV |
71 | gitlink:git-index-pack.html[1]:: |
72 | Build pack index file for an existing packed archive. | |
73 | ||
a7154e91 | 74 | gitlink:git-init-db[1]:: |
2cf565c5 DG |
75 | Creates an empty git object database |
76 | ||
a7154e91 | 77 | gitlink:git-merge-index[1]:: |
f85a4191 | 78 | Runs a merge for files needing merging |
215a7ad1 | 79 | Previously this command was known as git-merge-cache. |
2cf565c5 | 80 | |
a7154e91 | 81 | gitlink:git-mktag[1]:: |
2cf565c5 DG |
82 | Creates a tag object |
83 | ||
a7154e91 | 84 | gitlink:git-pack-objects[1]:: |
f85a4191 JH |
85 | Creates a packed archive of objects. |
86 | ||
a7154e91 | 87 | gitlink:git-prune-packed[1]:: |
f85a4191 JH |
88 | Remove extra objects that are already in pack files. |
89 | ||
a7154e91 | 90 | gitlink:git-read-tree[1]:: |
2cf565c5 DG |
91 | Reads tree information into the directory cache |
92 | ||
a7154e91 | 93 | gitlink:git-unpack-objects[1]:: |
f85a4191 JH |
94 | Unpacks objects out of a packed archive. |
95 | ||
a7154e91 | 96 | gitlink:git-update-index[1]:: |
2cf565c5 | 97 | Modifies the index or directory cache |
215a7ad1 | 98 | Previously this command was known as git-update-cache. |
2cf565c5 | 99 | |
a7154e91 | 100 | gitlink:git-write-tree[1]:: |
2cf565c5 DG |
101 | Creates a tree from the current cache |
102 | ||
e31bb3bb | 103 | |
2cf565c5 DG |
104 | Interrogation commands |
105 | ~~~~~~~~~~~~~~~~~~~~~~ | |
f85a4191 | 106 | |
a7154e91 | 107 | gitlink:git-cat-file[1]:: |
2cf565c5 DG |
108 | Provide content or type information for repository objects |
109 | ||
a7154e91 | 110 | gitlink:git-diff-index[1]:: |
2cf565c5 | 111 | Compares content and mode of blobs between the cache and repository |
215a7ad1 | 112 | Previously this command was known as git-diff-cache. |
2cf565c5 | 113 | |
a7154e91 | 114 | gitlink:git-diff-files[1]:: |
2cf565c5 DG |
115 | Compares files in the working tree and the cache |
116 | ||
a7154e91 | 117 | gitlink:git-diff-stages[1]:: |
83db04ff JH |
118 | Compares two "merge stages" in the index file. |
119 | ||
a7154e91 | 120 | gitlink:git-diff-tree[1]:: |
f85a4191 JH |
121 | Compares the content and mode of blobs found via two tree objects |
122 | ||
a7154e91 | 123 | gitlink:git-fsck-objects[1]:: |
2cf565c5 | 124 | Verifies the connectivity and validity of the objects in the database |
215a7ad1 | 125 | Previously this command was known as git-fsck-cache. |
2cf565c5 | 126 | |
a7154e91 | 127 | gitlink:git-ls-files[1]:: |
2cf565c5 DG |
128 | Information about files in the cache/working directory |
129 | ||
a7154e91 | 130 | gitlink:git-ls-tree[1]:: |
2cf565c5 DG |
131 | Displays a tree object in human readable form |
132 | ||
a7154e91 | 133 | gitlink:git-merge-base[1]:: |
f85a4191 | 134 | Finds as good a common ancestor as possible for a merge |
2cf565c5 | 135 | |
a60d2d8f JS |
136 | gitlink:git-name-rev[1]:: |
137 | Find symbolic names for given revs | |
138 | ||
a7154e91 | 139 | gitlink:git-rev-list[1]:: |
2cf565c5 DG |
140 | Lists commit objects in reverse chronological order |
141 | ||
a7154e91 | 142 | gitlink:git-show-index[1]:: |
f85a4191 JH |
143 | Displays contents of a pack idx file. |
144 | ||
a7154e91 | 145 | gitlink:git-tar-tree[1]:: |
2cf565c5 DG |
146 | Creates a tar archive of the files in the named tree |
147 | ||
a7154e91 | 148 | gitlink:git-unpack-file[1]:: |
2cf565c5 DG |
149 | Creates a temporary file with a blob's contents |
150 | ||
a7154e91 | 151 | gitlink:git-var[1]:: |
aed022ab EB |
152 | Displays a git logical variable |
153 | ||
a7154e91 | 154 | gitlink:git-verify-pack[1]:: |
72e9340c | 155 | Validates packed git archive files |
f9253394 | 156 | |
2cf565c5 DG |
157 | The interrogate commands may create files - and you can force them to |
158 | touch the working file set - but in general they don't | |
159 | ||
160 | ||
0c04094b JH |
161 | Synching repositories |
162 | ~~~~~~~~~~~~~~~~~~~~~ | |
163 | ||
a7154e91 | 164 | gitlink:git-clone-pack[1]:: |
6ec311da JH |
165 | Clones a repository into the current repository (engine |
166 | for ssh and local transport) | |
167 | ||
a7154e91 | 168 | gitlink:git-fetch-pack[1]:: |
f85a4191 JH |
169 | Updates from a remote repository. |
170 | ||
a7154e91 | 171 | gitlink:git-http-fetch[1]:: |
72e9340c | 172 | Downloads a remote git repository via HTTP |
215a7ad1 | 173 | Previously this command was known as git-http-pull. |
204ee6a9 | 174 | |
a7154e91 | 175 | gitlink:git-local-fetch[1]:: |
72e9340c | 176 | Duplicates another git repository on a local system |
215a7ad1 | 177 | Previously this command was known as git-local-pull. |
204ee6a9 | 178 | |
a7154e91 | 179 | gitlink:git-peek-remote[1]:: |
f85a4191 | 180 | Lists references on a remote repository using upload-pack protocol. |
2f2de9b4 | 181 | |
a7154e91 | 182 | gitlink:git-receive-pack[1]:: |
2f2de9b4 JH |
183 | Invoked by 'git-send-pack' to receive what is pushed to it. |
184 | ||
a7154e91 | 185 | gitlink:git-send-pack[1]:: |
f85a4191 | 186 | Pushes to a remote repository, intelligently. |
2f2de9b4 | 187 | |
d43367af PB |
188 | gitlink:git-shell[1]:: |
189 | Restricted shell for GIT-only SSH access. | |
190 | ||
a7154e91 | 191 | gitlink:git-ssh-fetch[1]:: |
f85a4191 | 192 | Pulls from a remote repository over ssh connection |
215a7ad1 | 193 | Previously this command was known as git-ssh-pull. |
508e67ab | 194 | |
a7154e91 | 195 | gitlink:git-ssh-upload[1]:: |
215a7ad1 JH |
196 | Helper "server-side" program used by git-ssh-fetch |
197 | Previously this command was known as git-ssh-push. | |
2f2de9b4 | 198 | |
a7154e91 | 199 | gitlink:git-update-server-info[1]:: |
61e3ef36 JH |
200 | Updates auxiliary information on a dumb server to help |
201 | clients discover references and packs on it. | |
202 | ||
a7154e91 | 203 | gitlink:git-upload-pack[1]:: |
f85a4191 JH |
204 | Invoked by 'git-clone-pack' and 'git-fetch-pack' to push |
205 | what are asked for. | |
206 | ||
2f2de9b4 | 207 | |
3f971fc4 JH |
208 | Porcelain-ish Commands |
209 | ---------------------- | |
905197de | 210 | |
a7154e91 | 211 | gitlink:git-add[1]:: |
905197de | 212 | Add paths to the index file. |
215a7ad1 | 213 | Previously this command was known as git-add-script. |
905197de | 214 | |
8548ea8d PB |
215 | gitlink:git-am[1]:: |
216 | Apply patches from a mailbox, but cooler. | |
217 | ||
a7154e91 | 218 | gitlink:git-applymbox[1]:: |
f85a4191 JH |
219 | Apply patches from a mailbox. |
220 | ||
a7154e91 | 221 | gitlink:git-bisect[1]:: |
f85a4191 | 222 | Find the change that introduced a bug. |
215a7ad1 | 223 | Previously this command was known as git-bisect-script. |
f85a4191 | 224 | |
a7154e91 | 225 | gitlink:git-branch[1]:: |
905197de | 226 | Create and Show branches. |
215a7ad1 | 227 | Previously this command was known as git-branch-script. |
905197de | 228 | |
a7154e91 | 229 | gitlink:git-checkout[1]:: |
452ce291 | 230 | Checkout and switch to a branch. |
215a7ad1 | 231 | Previously this command was known as git-checkout-script. |
452ce291 | 232 | |
a7154e91 | 233 | gitlink:git-cherry-pick[1]:: |
f85a4191 | 234 | Cherry-pick the effect of an existing commit. |
215a7ad1 | 235 | Previously this command was known as git-cherry-pick-script. |
3f971fc4 | 236 | |
a7154e91 | 237 | gitlink:git-clone[1]:: |
f85a4191 | 238 | Clones a repository into a new directory. |
215a7ad1 | 239 | Previously this command was known as git-clone-script. |
3f971fc4 | 240 | |
a7154e91 | 241 | gitlink:git-commit[1]:: |
f85a4191 | 242 | Record changes to the repository. |
215a7ad1 | 243 | Previously this command was known as git-commit-script. |
3f971fc4 | 244 | |
a7154e91 | 245 | gitlink:git-diff[1]:: |
2aba319a | 246 | Show changes between commits, commit and working tree, etc. |
35ef3a4c JH |
247 | Previously this command was known as git-diff-script. |
248 | ||
a7154e91 | 249 | gitlink:git-fetch[1]:: |
62033318 | 250 | Download from a remote repository via various protocols. |
215a7ad1 | 251 | Previously this command was known as git-fetch-script. |
62033318 | 252 | |
a7154e91 | 253 | gitlink:git-format-patch[1]:: |
2aba319a | 254 | Prepare patches for e-mail submission. |
35ef3a4c JH |
255 | Previously this command was known as git-format-patch-script. |
256 | ||
a7154e91 | 257 | gitlink:git-grep[1]:: |
2aba319a JH |
258 | Print lines matching a pattern |
259 | ||
a7154e91 | 260 | gitlink:git-log[1]:: |
f85a4191 | 261 | Shows commit logs. |
215a7ad1 | 262 | Previously this command was known as git-log-script. |
62033318 | 263 | |
a7154e91 | 264 | gitlink:git-ls-remote[1]:: |
f85a4191 | 265 | Shows references in a remote or local repository. |
215a7ad1 | 266 | Previously this command was known as git-ls-remote-script. |
ab9b3138 | 267 | |
a7154e91 | 268 | gitlink:git-merge[1]:: |
0f69be53 JH |
269 | Grand unified merge driver. |
270 | ||
8548ea8d PB |
271 | gitlink:git-mv[1]:: |
272 | Move or rename a file, a directory, or a symlink. | |
273 | ||
a7154e91 | 274 | gitlink:git-octopus[1]:: |
ab9b3138 | 275 | Merge more than two commits. |
215a7ad1 | 276 | Previously this command was known as git-octopus-script. |
ab9b3138 | 277 | |
a7154e91 | 278 | gitlink:git-pull[1]:: |
f85a4191 | 279 | Fetch from and merge with a remote repository. |
215a7ad1 | 280 | Previously this command was known as git-pull-script. |
f85a4191 | 281 | |
a7154e91 | 282 | gitlink:git-push[1]:: |
ab9b3138 | 283 | Update remote refs along with associated objects. |
215a7ad1 | 284 | Previously this command was known as git-push-script. |
ab9b3138 | 285 | |
a7154e91 | 286 | gitlink:git-rebase[1]:: |
f85a4191 | 287 | Rebase local commits to new upstream head. |
215a7ad1 | 288 | Previously this command was known as git-rebase-script. |
62033318 | 289 | |
a7154e91 | 290 | gitlink:git-rename[1]:: |
f85a4191 | 291 | Rename files and directories. |
215a7ad1 | 292 | Previously this command was known as git-rename-script. |
62033318 | 293 | |
a7154e91 | 294 | gitlink:git-repack[1]:: |
e31bb3bb | 295 | Pack unpacked objects in a repository. |
215a7ad1 | 296 | Previously this command was known as git-repack-script. |
e31bb3bb | 297 | |
a7154e91 | 298 | gitlink:git-reset[1]:: |
452ce291 | 299 | Reset current HEAD to the specified state. |
215a7ad1 | 300 | Previously this command was known as git-reset-script. |
452ce291 | 301 | |
a7154e91 | 302 | gitlink:git-resolve[1]:: |
f85a4191 | 303 | Merge two commits. |
215a7ad1 | 304 | Previously this command was known as git-resolve-script. |
83db04ff | 305 | |
a7154e91 | 306 | gitlink:git-revert[1]:: |
f85a4191 | 307 | Revert an existing commit. |
215a7ad1 | 308 | Previously this command was known as git-revert-script. |
f85a4191 | 309 | |
a7154e91 | 310 | gitlink:git-shortlog[1]:: |
f85a4191 JH |
311 | Summarizes 'git log' output. |
312 | ||
a7154e91 | 313 | gitlink:git-show-branch[1]:: |
f85a4191 JH |
314 | Show branches and their commits. |
315 | ||
a7154e91 | 316 | gitlink:git-status[1]:: |
f85a4191 | 317 | Shows the working tree status. |
215a7ad1 | 318 | Previously this command was known as git-status-script. |
83db04ff | 319 | |
a7154e91 | 320 | gitlink:git-verify-tag[1]:: |
905197de | 321 | Check the GPG signature of tag. |
215a7ad1 | 322 | Previously this command was known as git-verify-tag-script. |
905197de | 323 | |
a7154e91 | 324 | gitlink:git-whatchanged[1]:: |
f85a4191 JH |
325 | Shows commit logs and differences they introduce. |
326 | ||
e31bb3bb | 327 | |
90933efb YS |
328 | Ancillary Commands |
329 | ------------------ | |
2f2de9b4 JH |
330 | Manipulators: |
331 | ||
a7154e91 | 332 | gitlink:git-applypatch[1]:: |
f85a4191 | 333 | Apply one patch extracted from an e-mail. |
905197de | 334 | |
a7154e91 | 335 | gitlink:git-archimport[1]:: |
5077fa9c | 336 | Import an arch repository into git. |
215a7ad1 | 337 | Previously this command was known as git-archimport-script. |
5077fa9c | 338 | |
a7154e91 | 339 | gitlink:git-convert-objects[1]:: |
72e9340c | 340 | Converts old-style git repository |
215a7ad1 | 341 | Previously this command was known as git-convert-cache. |
2f2de9b4 | 342 | |
a7154e91 | 343 | gitlink:git-cvsimport[1]:: |
f85a4191 | 344 | Salvage your data out of another SCM people love to hate. |
215a7ad1 | 345 | Previously this command was known as git-cvsimport-script. |
f85a4191 | 346 | |
a7154e91 | 347 | gitlink:git-merge-one-file[1]:: |
215a7ad1 JH |
348 | The standard helper program to use with "git-merge-index" |
349 | Previously this command was known as git-merge-one-file-script. | |
204ee6a9 | 350 | |
a7154e91 | 351 | gitlink:git-prune[1]:: |
204ee6a9 | 352 | Prunes all unreachable objects from the object database |
215a7ad1 | 353 | Previously this command was known as git-prune-script. |
204ee6a9 | 354 | |
a7154e91 | 355 | gitlink:git-relink[1]:: |
f85a4191 | 356 | Hardlink common objects in local repositories. |
215a7ad1 | 357 | Previously this command was known as git-relink-script. |
f85a4191 | 358 | |
8548ea8d PB |
359 | gitlink:git-svnimport[1]:: |
360 | Import a SVN repository into git. | |
361 | ||
a7154e91 | 362 | gitlink:git-sh-setup[1]:: |
f85a4191 | 363 | Common git shell script setup code. |
215a7ad1 | 364 | Previously this command was known as git-sh-setup-script. |
f85a4191 | 365 | |
a60d2d8f JS |
366 | gitlink:git-symbolic-ref[1]:: |
367 | Read and modify symbolic refs | |
368 | ||
a7154e91 | 369 | gitlink:git-tag[1]:: |
204ee6a9 | 370 | An example script to create a tag object signed with GPG |
215a7ad1 | 371 | Previously this command was known as git-tag-script. |
204ee6a9 | 372 | |
8548ea8d PB |
373 | gitlink:git-update-ref[1]:: |
374 | Update the object name stored in a ref safely. | |
375 | ||
204ee6a9 | 376 | |
90933efb | 377 | Interrogators: |
204ee6a9 | 378 | |
8548ea8d PB |
379 | gitlink:git-check-ref-format[1]:: |
380 | Make sure ref name is well formed. | |
381 | ||
a7154e91 | 382 | gitlink:git-cherry[1]:: |
f85a4191 | 383 | Find commits not merged upstream. |
905197de | 384 | |
a7154e91 | 385 | gitlink:git-count-objects[1]:: |
905197de | 386 | Count unpacked number of objects and their disk consumption. |
215a7ad1 | 387 | Previously this command was known as git-count-objects-script. |
905197de | 388 | |
a7154e91 | 389 | gitlink:git-daemon[1]:: |
72e9340c | 390 | A really simple server for git repositories. |
5077fa9c | 391 | |
a7154e91 | 392 | gitlink:git-get-tar-commit-id[1]:: |
5077fa9c JH |
393 | Extract commit ID from an archive created using git-tar-tree. |
394 | ||
a7154e91 | 395 | gitlink:git-mailinfo[1]:: |
f85a4191 JH |
396 | Extracts patch from a single e-mail message. |
397 | ||
a7154e91 | 398 | gitlink:git-mailsplit[1]:: |
f85a4191 JH |
399 | git-mailsplit. |
400 | ||
a7154e91 | 401 | gitlink:git-patch-id[1]:: |
f85a4191 | 402 | Compute unique ID for a patch. |
204ee6a9 | 403 | |
a7154e91 | 404 | gitlink:git-parse-remote[1]:: |
5077fa9c | 405 | Routines to help parsing $GIT_DIR/remotes/ |
215a7ad1 | 406 | Previously this command was known as git-parse-remote-script. |
5077fa9c | 407 | |
a7154e91 | 408 | gitlink:git-request-pull[1]:: |
215a7ad1 JH |
409 | git-request-pull. |
410 | Previously this command was known as git-request-pull-script. | |
5077fa9c | 411 | |
a7154e91 | 412 | gitlink:git-rev-parse[1]:: |
5077fa9c JH |
413 | Pick out and massage parameters. |
414 | ||
a7154e91 | 415 | gitlink:git-send-email[1]:: |
83db04ff | 416 | Send patch e-mails out of "format-patch --mbox" output. |
215a7ad1 | 417 | Previously this command was known as git-send-email-script. |
204ee6a9 | 418 | |
8548ea8d PB |
419 | gitlink:git-symbolic-refs[1]:: |
420 | Read and modify symbolic refs. | |
421 | ||
a7154e91 | 422 | gitlink:git-stripspace[1]:: |
35ef3a4c | 423 | Filter out empty lines. |
7fc9d69f | 424 | |
7fc9d69f | 425 | |
35ef3a4c JH |
426 | Commands not yet documented |
427 | --------------------------- | |
7fc9d69f | 428 | |
a7154e91 | 429 | gitlink:gitk[1]:: |
7fc9d69f JH |
430 | gitk. |
431 | ||
432 | ||
5773c9f2 JH |
433 | Configuration Mechanism |
434 | ----------------------- | |
435 | ||
436 | Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file | |
437 | is used to hold per-repository configuration options. It is a | |
438 | simple text file modelled after `.ini` format familiar to some | |
439 | people. Here is an example: | |
440 | ||
441 | ------------ | |
442 | # | |
443 | # This is the config file, and | |
444 | # a '#' or ';' character indicates | |
445 | # a comment | |
446 | # | |
447 | ||
448 | ; core variables | |
449 | [core] | |
450 | ; Don't trust file modes | |
451 | filemode = false | |
452 | ||
453 | ; user identity | |
454 | [user] | |
455 | name = "Junio C Hamano" | |
456 | email = "junkio@twinsun.com" | |
457 | ||
458 | ------------ | |
459 | ||
460 | Various commands read from the configuration file and adjust | |
461 | their operation accordingly. | |
462 | ||
463 | ||
6c84e2e0 | 464 | Identifier Terminology |
2cf565c5 DG |
465 | ---------------------- |
466 | <object>:: | |
6c84e2e0 | 467 | Indicates the sha1 identifier for any type of object |
2cf565c5 DG |
468 | |
469 | <blob>:: | |
470 | Indicates a blob object sha1 identifier | |
471 | ||
472 | <tree>:: | |
473 | Indicates a tree object sha1 identifier | |
474 | ||
475 | <commit>:: | |
476 | Indicates a commit object sha1 identifier | |
477 | ||
478 | <tree-ish>:: | |
6c84e2e0 DG |
479 | Indicates a tree, commit or tag object sha1 identifier. A |
480 | command that takes a <tree-ish> argument ultimately wants to | |
481 | operate on a <tree> object but automatically dereferences | |
482 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 DG |
483 | |
484 | <type>:: | |
485 | Indicates that an object type is required. | |
486 | Currently one of: blob/tree/commit/tag | |
487 | ||
488 | <file>:: | |
489 | Indicates a filename - always relative to the root of | |
490 | the tree structure GIT_INDEX_FILE describes. | |
491 | ||
c1bdacf9 DG |
492 | Symbolic Identifiers |
493 | -------------------- | |
90933efb | 494 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 495 | symbolic notation: |
c1bdacf9 DG |
496 | |
497 | HEAD:: | |
6c84e2e0 DG |
498 | indicates the head of the repository (ie the contents of |
499 | `$GIT_DIR/HEAD`) | |
c1bdacf9 DG |
500 | <tag>:: |
501 | a valid tag 'name'+ | |
502 | (ie the contents of `$GIT_DIR/refs/tags/<tag>`) | |
503 | <head>:: | |
504 | a valid head 'name'+ | |
505 | (ie the contents of `$GIT_DIR/refs/heads/<head>`) | |
506 | <snap>:: | |
507 | a valid snapshot 'name'+ | |
508 | (ie the contents of `$GIT_DIR/refs/snap/<snap>`) | |
509 | ||
510 | ||
511 | File/Directory Structure | |
512 | ------------------------ | |
c1bdacf9 | 513 | |
a1d4aa74 | 514 | Please see link:repository-layout.html[repository layout] document. |
c1bdacf9 DG |
515 | |
516 | Higher level SCMs may provide and manage additional information in the | |
517 | GIT_DIR. | |
518 | ||
a1d4aa74 | 519 | |
2cf565c5 DG |
520 | Terminology |
521 | ----------- | |
1bff6490 | 522 | Please see link:glossary.html[glossary] document. |
2cf565c5 DG |
523 | |
524 | ||
525 | Environment Variables | |
526 | --------------------- | |
527 | Various git commands use the following environment variables: | |
528 | ||
c1bdacf9 DG |
529 | The git Repository |
530 | ~~~~~~~~~~~~~~~~~~ | |
531 | These environment variables apply to 'all' core git commands. Nb: it | |
532 | is worth noting that they may be used/overridden by SCMS sitting above | |
533 | git so take care if using Cogito etc | |
534 | ||
535 | 'GIT_INDEX_FILE':: | |
536 | This environment allows the specification of an alternate | |
537 | cache/index file. If not specified, the default of | |
538 | `$GIT_DIR/index` is used. | |
539 | ||
540 | 'GIT_OBJECT_DIRECTORY':: | |
541 | If the object storage directory is specified via this | |
542 | environment variable then the sha1 directories are created | |
543 | underneath - otherwise the default `$GIT_DIR/objects` | |
544 | directory is used. | |
545 | ||
546 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
547 | Due to the immutable nature of git objects, old objects can be | |
548 | archived into shared, read-only directories. This variable | |
90933efb | 549 | specifies a ":" separated list of git object directories which |
c1bdacf9 DG |
550 | can be used to search for git objects. New objects will not be |
551 | written to these directories. | |
552 | ||
553 | 'GIT_DIR':: | |
554 | If the 'GIT_DIR' environment variable is set then it specifies | |
555 | a path to use instead of `./.git` for the base of the | |
556 | repository. | |
557 | ||
558 | git Commits | |
559 | ~~~~~~~~~~~ | |
560 | 'GIT_AUTHOR_NAME':: | |
561 | 'GIT_AUTHOR_EMAIL':: | |
562 | 'GIT_AUTHOR_DATE':: | |
563 | 'GIT_COMMITTER_NAME':: | |
564 | 'GIT_COMMITTER_EMAIL':: | |
a7154e91 | 565 | see gitlink:git-commit-tree[1] |
c1bdacf9 DG |
566 | |
567 | git Diffs | |
568 | ~~~~~~~~~ | |
d81ed1b5 JH |
569 | 'GIT_DIFF_OPTS':: |
570 | 'GIT_EXTERNAL_DIFF':: | |
c1bdacf9 | 571 | see the "generating patches" section in : |
a7154e91 SV |
572 | gitlink:git-diff-index[1]; |
573 | gitlink:git-diff-files[1]; | |
574 | gitlink:git-diff-tree[1] | |
2cf565c5 | 575 | |
8db9307c JH |
576 | Discussion[[Discussion]] |
577 | ------------------------ | |
6c84e2e0 DG |
578 | include::../README[] |
579 | ||
2cf565c5 DG |
580 | Author |
581 | ------ | |
6c84e2e0 | 582 | Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>. |
2cf565c5 DG |
583 | |
584 | Documentation | |
585 | -------------- | |
586 | Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. | |
587 | ||
588 | GIT | |
589 | --- | |
a7154e91 | 590 | Part of the gitlink:git[7] suite |
2cf565c5 | 591 |