Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 1 | git(1) |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 2 | ====== |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | git - the stupid content tracker |
| 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
Jonas Fonseca | 8b70004 | 2006-08-25 03:05:48 +0200 | [diff] [blame] | 11 | [verse] |
Markus Heidelberg | 89a56bf | 2009-04-05 04:15:16 +0200 | [diff] [blame] | 12 | 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path] |
Matthieu Moy | 463a849 | 2007-08-19 19:24:36 +0200 | [diff] [blame] | 13 | [-p|--paginate|--no-pager] |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 14 | [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] |
| 15 | [--help] COMMAND [ARGS] |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 16 | |
| 17 | DESCRIPTION |
| 18 | ----------- |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 19 | Git is a fast, scalable, distributed revision control system with an |
| 20 | unusually rich command set that provides both high-level operations |
| 21 | and full access to internals. |
| 22 | |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 23 | See linkgit:gittutorial[7] to get started, then see |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 24 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and |
| 25 | "man git-commandname" for documentation of each command. CVS users may |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 26 | also want to read linkgit:gitcvs-migration[7]. See |
| 27 | the link:user-manual.html[Git User's Manual] for a more in-depth |
J. Bruce Fields | a1dc34f | 2007-05-07 01:01:42 -0400 | [diff] [blame] | 28 | introduction. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 29 | |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 30 | The COMMAND is either a name of a Git command (see below) or an alias |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 31 | as defined in the configuration file (see linkgit:git-config[1]). |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 32 | |
Jari Aalto | 34b604a | 2007-04-30 14:21:38 +0300 | [diff] [blame] | 33 | Formatted and hyperlinked version of the latest git |
| 34 | documentation can be viewed at |
| 35 | `http://www.kernel.org/pub/software/scm/git/docs/`. |
| 36 | |
Junio C Hamano | 26cfcfb | 2007-02-13 15:15:05 -0800 | [diff] [blame] | 37 | ifdef::stalenotes[] |
| 38 | [NOTE] |
| 39 | ============ |
Junio C Hamano | 26cfcfb | 2007-02-13 15:15:05 -0800 | [diff] [blame] | 40 | |
Junio C Hamano | 2ff3f61 | 2007-05-18 21:43:13 -0700 | [diff] [blame] | 41 | You are reading the documentation for the latest (possibly |
| 42 | unreleased) version of git, that is available from 'master' |
| 43 | branch of the `git.git` repository. |
| 44 | Documentation for older releases are available here: |
Junio C Hamano | 43a8e4f | 2007-03-28 15:40:17 -0700 | [diff] [blame] | 45 | |
Junio C Hamano | f01f109 | 2009-05-06 17:13:27 -0700 | [diff] [blame] | 46 | * link:v1.6.3/git.html[documentation for release 1.6.3] |
Junio C Hamano | a95148d | 2009-03-03 23:02:16 -0800 | [diff] [blame] | 47 | |
| 48 | * release notes for |
Junio C Hamano | f01f109 | 2009-05-06 17:13:27 -0700 | [diff] [blame] | 49 | link:RelNotes-1.6.2.5.txt[1.6.2.5], |
| 50 | link:RelNotes-1.6.2.4.txt[1.6.2.4], |
Junio C Hamano | c965c02 | 2009-04-12 17:05:55 -0700 | [diff] [blame] | 51 | link:RelNotes-1.6.2.3.txt[1.6.2.3], |
Nanako Shiraishi | 54a4749 | 2009-04-10 09:34:40 +0900 | [diff] [blame] | 52 | link:RelNotes-1.6.2.2.txt[1.6.2.2], |
Junio C Hamano | de76978 | 2009-03-15 13:10:10 -0700 | [diff] [blame] | 53 | link:RelNotes-1.6.2.1.txt[1.6.2.1], |
Junio C Hamano | a95148d | 2009-03-03 23:02:16 -0800 | [diff] [blame] | 54 | link:RelNotes-1.6.2.txt[1.6.2]. |
| 55 | |
Junio C Hamano | 621f1b4 | 2009-02-07 11:06:34 -0800 | [diff] [blame] | 56 | * link:v1.6.1.3/git.html[documentation for release 1.6.1.3] |
Junio C Hamano | 8104ebf | 2008-12-24 19:41:08 -0800 | [diff] [blame] | 57 | |
| 58 | * release notes for |
Junio C Hamano | 621f1b4 | 2009-02-07 11:06:34 -0800 | [diff] [blame] | 59 | link:RelNotes-1.6.1.3.txt[1.6.1.3], |
| 60 | link:RelNotes-1.6.1.2.txt[1.6.1.2], |
Junio C Hamano | c42b1ad | 2009-01-25 16:30:13 -0800 | [diff] [blame] | 61 | link:RelNotes-1.6.1.1.txt[1.6.1.1], |
Junio C Hamano | 8104ebf | 2008-12-24 19:41:08 -0800 | [diff] [blame] | 62 | link:RelNotes-1.6.1.txt[1.6.1]. |
| 63 | |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 64 | * link:v1.6.0.6/git.html[documentation for release 1.6.0.6] |
Junio C Hamano | ea02eef | 2008-08-17 11:42:10 -0700 | [diff] [blame] | 65 | |
| 66 | * release notes for |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 67 | link:RelNotes-1.6.0.6.txt[1.6.0.6], |
Junio C Hamano | f371d3e | 2008-12-07 17:34:14 -0800 | [diff] [blame] | 68 | link:RelNotes-1.6.0.5.txt[1.6.0.5], |
Junio C Hamano | 171d766 | 2008-11-12 15:04:54 -0800 | [diff] [blame] | 69 | link:RelNotes-1.6.0.4.txt[1.6.0.4], |
| 70 | link:RelNotes-1.6.0.3.txt[1.6.0.3], |
Junio C Hamano | 97a7a82 | 2008-09-12 16:18:47 -0700 | [diff] [blame] | 71 | link:RelNotes-1.6.0.2.txt[1.6.0.2], |
| 72 | link:RelNotes-1.6.0.1.txt[1.6.0.1], |
Junio C Hamano | ea02eef | 2008-08-17 11:42:10 -0700 | [diff] [blame] | 73 | link:RelNotes-1.6.0.txt[1.6.0]. |
| 74 | |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 75 | * link:v1.5.6.6/git.html[documentation for release 1.5.6.6] |
Junio C Hamano | e449f10 | 2008-06-18 13:09:43 -0700 | [diff] [blame] | 76 | |
| 77 | * release notes for |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 78 | link:RelNotes-1.5.6.6.txt[1.5.6.6], |
Junio C Hamano | 781c1834 | 2008-08-06 12:04:06 -0700 | [diff] [blame] | 79 | link:RelNotes-1.5.6.5.txt[1.5.6.5], |
Junio C Hamano | 09651dd | 2008-07-19 15:52:12 -0700 | [diff] [blame] | 80 | link:RelNotes-1.5.6.4.txt[1.5.6.4], |
| 81 | link:RelNotes-1.5.6.3.txt[1.5.6.3], |
| 82 | link:RelNotes-1.5.6.2.txt[1.5.6.2], |
| 83 | link:RelNotes-1.5.6.1.txt[1.5.6.1], |
Junio C Hamano | e636106 | 2008-06-25 17:09:40 -0700 | [diff] [blame] | 84 | link:RelNotes-1.5.6.txt[1.5.6]. |
Junio C Hamano | e449f10 | 2008-06-18 13:09:43 -0700 | [diff] [blame] | 85 | |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 86 | * link:v1.5.5.6/git.html[documentation for release 1.5.5.6] |
Junio C Hamano | 1d2375d | 2008-04-07 21:57:43 -0700 | [diff] [blame] | 87 | |
| 88 | * release notes for |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 89 | link:RelNotes-1.5.5.6.txt[1.5.5.6], |
| 90 | link:RelNotes-1.5.5.5.txt[1.5.5.5], |
Junio C Hamano | 7064ca5 | 2008-06-07 11:45:48 -0700 | [diff] [blame] | 91 | link:RelNotes-1.5.5.4.txt[1.5.5.4], |
Junio C Hamano | 28bc302 | 2008-05-27 22:20:53 -0700 | [diff] [blame] | 92 | link:RelNotes-1.5.5.3.txt[1.5.5.3], |
Junio C Hamano | 2d3922d | 2008-05-25 21:14:09 -0700 | [diff] [blame] | 93 | link:RelNotes-1.5.5.2.txt[1.5.5.2], |
Junio C Hamano | 66aaa2f | 2008-04-20 11:36:53 -0700 | [diff] [blame] | 94 | link:RelNotes-1.5.5.1.txt[1.5.5.1], |
Junio C Hamano | 1d2375d | 2008-04-07 21:57:43 -0700 | [diff] [blame] | 95 | link:RelNotes-1.5.5.txt[1.5.5]. |
| 96 | |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 97 | * link:v1.5.4.7/git.html[documentation for release 1.5.4.7] |
Junio C Hamano | 6ce8e44 | 2008-02-01 20:40:30 -0800 | [diff] [blame] | 98 | |
| 99 | * release notes for |
Junio C Hamano | efe05b0 | 2008-12-19 19:32:29 -0800 | [diff] [blame] | 100 | link:RelNotes-1.5.4.7.txt[1.5.4.7], |
| 101 | link:RelNotes-1.5.4.6.txt[1.5.4.6], |
Junio C Hamano | 803d515 | 2008-03-27 20:43:51 -0700 | [diff] [blame] | 102 | link:RelNotes-1.5.4.5.txt[1.5.4.5], |
Junio C Hamano | ad416ed | 2008-03-08 20:07:49 -0800 | [diff] [blame] | 103 | link:RelNotes-1.5.4.4.txt[1.5.4.4], |
Junio C Hamano | 923d44a | 2008-02-23 11:49:34 -0800 | [diff] [blame] | 104 | link:RelNotes-1.5.4.3.txt[1.5.4.3], |
Junio C Hamano | cf5c51e | 2008-02-17 01:18:54 -0800 | [diff] [blame] | 105 | link:RelNotes-1.5.4.2.txt[1.5.4.2], |
Junio C Hamano | ecb879f | 2008-02-11 19:21:23 -0800 | [diff] [blame] | 106 | link:RelNotes-1.5.4.1.txt[1.5.4.1], |
Junio C Hamano | 6ce8e44 | 2008-02-01 20:40:30 -0800 | [diff] [blame] | 107 | link:RelNotes-1.5.4.txt[1.5.4]. |
| 108 | |
Junio C Hamano | e708af6 | 2008-01-07 23:39:02 -0800 | [diff] [blame] | 109 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
Junio C Hamano | 5587cac | 2007-09-02 15:16:44 -0700 | [diff] [blame] | 110 | |
| 111 | * release notes for |
Junio C Hamano | e708af6 | 2008-01-07 23:39:02 -0800 | [diff] [blame] | 112 | link:RelNotes-1.5.3.8.txt[1.5.3.8], |
Junio C Hamano | b52e985 | 2007-12-01 12:48:19 -0800 | [diff] [blame] | 113 | link:RelNotes-1.5.3.7.txt[1.5.3.7], |
Junio C Hamano | 4a44b9e | 2007-11-18 15:15:47 -0800 | [diff] [blame] | 114 | link:RelNotes-1.5.3.6.txt[1.5.3.6], |
Junio C Hamano | afc05f9 | 2007-10-31 14:13:25 -0700 | [diff] [blame] | 115 | link:RelNotes-1.5.3.5.txt[1.5.3.5], |
Junio C Hamano | 58ba4f6 | 2007-10-04 01:35:01 -0700 | [diff] [blame] | 116 | link:RelNotes-1.5.3.4.txt[1.5.3.4], |
Junio C Hamano | 326df26 | 2007-09-30 17:32:25 -0700 | [diff] [blame] | 117 | link:RelNotes-1.5.3.3.txt[1.5.3.3], |
Junio C Hamano | 077d6f7 | 2007-09-19 03:21:35 -0700 | [diff] [blame] | 118 | link:RelNotes-1.5.3.2.txt[1.5.3.2], |
Junio C Hamano | 8d863c9 | 2007-10-23 12:10:55 -0700 | [diff] [blame] | 119 | link:RelNotes-1.5.3.1.txt[1.5.3.1], |
| 120 | link:RelNotes-1.5.3.txt[1.5.3]. |
Junio C Hamano | b6e4db6 | 2007-05-18 17:28:24 -0700 | [diff] [blame] | 121 | |
Junio C Hamano | e636106 | 2008-06-25 17:09:40 -0700 | [diff] [blame] | 122 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
| 123 | |
Junio C Hamano | aba170c | 2007-05-20 00:30:39 -0700 | [diff] [blame] | 124 | * release notes for |
Junio C Hamano | da899de | 2007-08-15 16:59:27 -0700 | [diff] [blame] | 125 | link:RelNotes-1.5.2.5.txt[1.5.2.5], |
Junio C Hamano | baafd6e | 2007-07-12 14:17:26 -0700 | [diff] [blame] | 126 | link:RelNotes-1.5.2.4.txt[1.5.2.4], |
Junio C Hamano | 444649e | 2007-07-02 01:14:00 -0700 | [diff] [blame] | 127 | link:RelNotes-1.5.2.3.txt[1.5.2.3], |
Junio C Hamano | 3e48af3 | 2007-06-16 09:10:18 -0700 | [diff] [blame] | 128 | link:RelNotes-1.5.2.2.txt[1.5.2.2], |
| 129 | link:RelNotes-1.5.2.1.txt[1.5.2.1], |
Junio C Hamano | aba170c | 2007-05-20 00:30:39 -0700 | [diff] [blame] | 130 | link:RelNotes-1.5.2.txt[1.5.2]. |
| 131 | |
| 132 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] |
| 133 | |
| 134 | * release notes for |
| 135 | link:RelNotes-1.5.1.6.txt[1.5.1.6], |
| 136 | link:RelNotes-1.5.1.5.txt[1.5.1.5], |
Junio C Hamano | 2ff3f61 | 2007-05-18 21:43:13 -0700 | [diff] [blame] | 137 | link:RelNotes-1.5.1.4.txt[1.5.1.4], |
| 138 | link:RelNotes-1.5.1.3.txt[1.5.1.3], |
| 139 | link:RelNotes-1.5.1.2.txt[1.5.1.2], |
| 140 | link:RelNotes-1.5.1.1.txt[1.5.1.1], |
| 141 | link:RelNotes-1.5.1.txt[1.5.1]. |
Junio C Hamano | 467592e | 2007-05-08 23:47:35 -0700 | [diff] [blame] | 142 | |
Junio C Hamano | 2ff3f61 | 2007-05-18 21:43:13 -0700 | [diff] [blame] | 143 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] |
Junio C Hamano | 467592e | 2007-05-08 23:47:35 -0700 | [diff] [blame] | 144 | |
Junio C Hamano | aba170c | 2007-05-20 00:30:39 -0700 | [diff] [blame] | 145 | * release notes for |
| 146 | link:RelNotes-1.5.0.7.txt[1.5.0.7], |
Junio C Hamano | 2ff3f61 | 2007-05-18 21:43:13 -0700 | [diff] [blame] | 147 | link:RelNotes-1.5.0.6.txt[1.5.0.6], |
| 148 | link:RelNotes-1.5.0.5.txt[1.5.0.5], |
| 149 | link:RelNotes-1.5.0.3.txt[1.5.0.3], |
| 150 | link:RelNotes-1.5.0.2.txt[1.5.0.2], |
| 151 | link:RelNotes-1.5.0.1.txt[1.5.0.1], |
| 152 | link:RelNotes-1.5.0.txt[1.5.0]. |
Junio C Hamano | fdd3e7d | 2007-04-21 23:51:27 -0700 | [diff] [blame] | 153 | |
Junio C Hamano | 2ff3f61 | 2007-05-18 21:43:13 -0700 | [diff] [blame] | 154 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], |
| 155 | link:v1.3.3/git.html[1.3.3], |
| 156 | link:v1.2.6/git.html[1.2.6], |
| 157 | link:v1.0.13/git.html[1.0.13]. |
Junio C Hamano | 26cfcfb | 2007-02-13 15:15:05 -0800 | [diff] [blame] | 158 | |
| 159 | ============ |
| 160 | |
| 161 | endif::stalenotes[] |
| 162 | |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 163 | OPTIONS |
| 164 | ------- |
| 165 | --version:: |
Fredrik Kuivinen | a87cd02 | 2006-03-09 17:24:19 +0100 | [diff] [blame] | 166 | Prints the git suite version that the 'git' program came from. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 167 | |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 168 | --help:: |
Fredrik Kuivinen | a87cd02 | 2006-03-09 17:24:19 +0100 | [diff] [blame] | 169 | Prints the synopsis and a list of the most commonly used |
Christian Couder | 0f6f195 | 2007-12-04 06:44:29 +0100 | [diff] [blame] | 170 | commands. If the option '--all' or '-a' is given then all |
| 171 | available commands are printed. If a git command is named this |
| 172 | option will bring up the manual page for that command. |
Christian Couder | 45533d2 | 2007-12-04 06:44:29 +0100 | [diff] [blame] | 173 | + |
| 174 | Other options are available to control how the manual page is |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 175 | displayed. See linkgit:git-help[1] for more information, |
Jonathan Nieder | db5d666 | 2008-07-03 01:06:23 -0500 | [diff] [blame] | 176 | because `git --help ...` is converted internally into `git |
| 177 | help ...`. |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 178 | |
| 179 | --exec-path:: |
Fredrik Kuivinen | a87cd02 | 2006-03-09 17:24:19 +0100 | [diff] [blame] | 180 | Path to wherever your core git programs are installed. |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 181 | This can also be controlled by setting the GIT_EXEC_PATH |
Jonathan Nieder | 56992f7 | 2008-07-03 00:08:12 -0500 | [diff] [blame] | 182 | environment variable. If no path is given, 'git' will print |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 183 | the current setting and then exit. |
| 184 | |
Markus Heidelberg | 89a56bf | 2009-04-05 04:15:16 +0200 | [diff] [blame] | 185 | --html-path:: |
| 186 | Print the path to wherever your git HTML documentation is installed |
| 187 | and exit. |
| 188 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 189 | -p:: |
| 190 | --paginate:: |
Johannes Schindelin | 6acbcb9 | 2006-07-25 20:24:22 +0200 | [diff] [blame] | 191 | Pipe all output into 'less' (or if set, $PAGER). |
| 192 | |
Matthieu Moy | 463a849 | 2007-08-19 19:24:36 +0200 | [diff] [blame] | 193 | --no-pager:: |
| 194 | Do not pipe git output into a pager. |
| 195 | |
Johannes Schindelin | 6acbcb9 | 2006-07-25 20:24:22 +0200 | [diff] [blame] | 196 | --git-dir=<path>:: |
| 197 | Set the path to the repository. This can also be controlled by |
Liu Yubao | 302cc11 | 2008-04-29 04:09:20 +0800 | [diff] [blame] | 198 | setting the GIT_DIR environment variable. It can be an absolute |
| 199 | path or relative path to current working directory. |
Johannes Schindelin | 6acbcb9 | 2006-07-25 20:24:22 +0200 | [diff] [blame] | 200 | |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 201 | --work-tree=<path>:: |
| 202 | Set the path to the working tree. The value will not be |
| 203 | used in combination with repositories found automatically in |
| 204 | a .git directory (i.e. $GIT_DIR is not set). |
| 205 | This can also be controlled by setting the GIT_WORK_TREE |
| 206 | environment variable and the core.worktree configuration |
Liu Yubao | 302cc11 | 2008-04-29 04:09:20 +0800 | [diff] [blame] | 207 | variable. It can be an absolute path or relative path to |
| 208 | the directory specified by --git-dir or GIT_DIR. |
| 209 | Note: If --git-dir or GIT_DIR are specified but none of |
| 210 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
| 211 | the current working directory is regarded as the top directory |
| 212 | of your working tree. |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 213 | |
Johannes Schindelin | 6acbcb9 | 2006-07-25 20:24:22 +0200 | [diff] [blame] | 214 | --bare:: |
Junio C Hamano | 9277d60 | 2007-08-27 22:41:23 -0700 | [diff] [blame] | 215 | Treat the repository as a bare repository. If GIT_DIR |
| 216 | environment is not set, it is set to the current working |
| 217 | directory. |
| 218 | |
Junio C Hamano | 0d6a873 | 2005-08-23 21:18:49 -0700 | [diff] [blame] | 219 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 220 | FURTHER DOCUMENTATION |
| 221 | --------------------- |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 222 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 223 | See the references above to get started using git. The following is |
| 224 | probably more detail than necessary for a first-time user. |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 225 | |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 226 | The link:user-manual.html#git-concepts[git concepts chapter of the |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 227 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 228 | introductions to the underlying git architecture. |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 229 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 230 | See also the link:howto-index.html[howto] documents for some useful |
| 231 | examples. |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 232 | |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 233 | The internals are documented in the |
| 234 | link:technical/api-index.html[GIT API documentation]. |
Junio C Hamano | 530e741 | 2007-11-24 23:48:04 -0800 | [diff] [blame] | 235 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 236 | GIT COMMANDS |
| 237 | ------------ |
Junio C Hamano | 8db9307 | 2005-08-30 13:51:01 -0700 | [diff] [blame] | 238 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 239 | We divide git into high level ("porcelain") commands and low level |
| 240 | ("plumbing") commands. |
Junio C Hamano | e6fc234 | 2005-08-25 00:28:18 -0700 | [diff] [blame] | 241 | |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 242 | High-level commands (porcelain) |
| 243 | ------------------------------- |
| 244 | |
| 245 | We separate the porcelain commands into the main commands and some |
| 246 | ancillary user utilities. |
| 247 | |
| 248 | Main porcelain commands |
| 249 | ~~~~~~~~~~~~~~~~~~~~~~~ |
Junio C Hamano | 905197d | 2005-08-26 21:33:46 -0700 | [diff] [blame] | 250 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 251 | include::cmds-mainporcelain.txt[] |
Junio C Hamano | e31bb3b | 2005-08-15 15:48:47 -0700 | [diff] [blame] | 252 | |
Yasushi SHOJI | 90933ef | 2005-08-16 00:23:06 +0900 | [diff] [blame] | 253 | Ancillary Commands |
J. Bruce Fields | 23091e9 | 2006-04-02 17:54:34 -0400 | [diff] [blame] | 254 | ~~~~~~~~~~~~~~~~~~ |
David Greaves | 204ee6a | 2005-05-10 22:32:37 +0100 | [diff] [blame] | 255 | Manipulators: |
| 256 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 257 | include::cmds-ancillarymanipulators.txt[] |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 258 | |
Junio C Hamano | f85a419 | 2005-08-29 17:21:06 -0700 | [diff] [blame] | 259 | Interrogators: |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 260 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 261 | include::cmds-ancillaryinterrogators.txt[] |
Junio C Hamano | 35ef3a4 | 2005-09-07 23:04:52 -0700 | [diff] [blame] | 262 | |
Junio C Hamano | 89bf207 | 2007-01-18 22:32:38 -0800 | [diff] [blame] | 263 | |
| 264 | Interacting with Others |
| 265 | ~~~~~~~~~~~~~~~~~~~~~~~ |
| 266 | |
| 267 | These commands are to interact with foreign SCM and with other |
| 268 | people via patch over e-mail. |
| 269 | |
| 270 | include::cmds-foreignscminterface.txt[] |
| 271 | |
| 272 | |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 273 | Low-level commands (plumbing) |
| 274 | ----------------------------- |
| 275 | |
| 276 | Although git includes its |
| 277 | own porcelain layer, its low-level commands are sufficient to support |
| 278 | development of alternative porcelains. Developers of such porcelains |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 279 | might start by reading about linkgit:git-update-index[1] and |
| 280 | linkgit:git-read-tree[1]. |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 281 | |
Junio C Hamano | 89bf207 | 2007-01-18 22:32:38 -0800 | [diff] [blame] | 282 | The interface (input, output, set of options and the semantics) |
| 283 | to these low-level commands are meant to be a lot more stable |
| 284 | than Porcelain level commands, because these commands are |
| 285 | primarily for scripted use. The interface to Porcelain commands |
| 286 | on the other hand are subject to change in order to improve the |
| 287 | end user experience. |
| 288 | |
| 289 | The following description divides |
| 290 | the low-level commands into commands that manipulate objects (in |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 291 | the repository, index, and working tree), commands that interrogate and |
| 292 | compare objects, and commands that move objects and references between |
| 293 | repositories. |
| 294 | |
Junio C Hamano | 89bf207 | 2007-01-18 22:32:38 -0800 | [diff] [blame] | 295 | |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 296 | Manipulation commands |
| 297 | ~~~~~~~~~~~~~~~~~~~~~ |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 298 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 299 | include::cmds-plumbingmanipulators.txt[] |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 300 | |
| 301 | |
| 302 | Interrogation commands |
| 303 | ~~~~~~~~~~~~~~~~~~~~~~ |
| 304 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 305 | include::cmds-plumbinginterrogators.txt[] |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 306 | |
| 307 | In general, the interrogate commands do not touch the files in |
| 308 | the working tree. |
| 309 | |
| 310 | |
| 311 | Synching repositories |
| 312 | ~~~~~~~~~~~~~~~~~~~~~ |
| 313 | |
Junio C Hamano | 377e813 | 2007-01-18 15:03:13 -0800 | [diff] [blame] | 314 | include::cmds-synchingrepositories.txt[] |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 315 | |
Junio C Hamano | 89bf207 | 2007-01-18 22:32:38 -0800 | [diff] [blame] | 316 | The following are helper programs used by the above; end users |
| 317 | typically do not use them directly. |
| 318 | |
| 319 | include::cmds-synchelpers.txt[] |
| 320 | |
| 321 | |
| 322 | Internal helper commands |
| 323 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 324 | |
| 325 | These are internal helper commands used by other commands; end |
| 326 | users typically do not use them directly. |
| 327 | |
| 328 | include::cmds-purehelpers.txt[] |
| 329 | |
Robin Rosenberg | b1f33d6 | 2006-10-29 21:09:48 +0100 | [diff] [blame] | 330 | |
Junio C Hamano | 5773c9f | 2005-10-29 14:32:56 -0700 | [diff] [blame] | 331 | Configuration Mechanism |
| 332 | ----------------------- |
| 333 | |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 334 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
Junio C Hamano | 5773c9f | 2005-10-29 14:32:56 -0700 | [diff] [blame] | 335 | is used to hold per-repository configuration options. It is a |
Pavel Roskin | addf88e | 2006-07-09 03:44:30 -0400 | [diff] [blame] | 336 | simple text file modeled after `.ini` format familiar to some |
Junio C Hamano | 5773c9f | 2005-10-29 14:32:56 -0700 | [diff] [blame] | 337 | people. Here is an example: |
| 338 | |
| 339 | ------------ |
| 340 | # |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 341 | # A '#' or ';' character indicates a comment. |
Junio C Hamano | 5773c9f | 2005-10-29 14:32:56 -0700 | [diff] [blame] | 342 | # |
| 343 | |
| 344 | ; core variables |
| 345 | [core] |
| 346 | ; Don't trust file modes |
| 347 | filemode = false |
| 348 | |
| 349 | ; user identity |
| 350 | [user] |
| 351 | name = "Junio C Hamano" |
| 352 | email = "junkio@twinsun.com" |
| 353 | |
| 354 | ------------ |
| 355 | |
| 356 | Various commands read from the configuration file and adjust |
| 357 | their operation accordingly. |
| 358 | |
| 359 | |
David Greaves | 6c84e2e | 2005-05-22 18:44:16 +0100 | [diff] [blame] | 360 | Identifier Terminology |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 361 | ---------------------- |
| 362 | <object>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 363 | Indicates the object name for any type of object. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 364 | |
| 365 | <blob>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 366 | Indicates a blob object name. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 367 | |
| 368 | <tree>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 369 | Indicates a tree object name. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 370 | |
| 371 | <commit>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 372 | Indicates a commit object name. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 373 | |
| 374 | <tree-ish>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 375 | Indicates a tree, commit or tag object name. A |
David Greaves | 6c84e2e | 2005-05-22 18:44:16 +0100 | [diff] [blame] | 376 | command that takes a <tree-ish> argument ultimately wants to |
| 377 | operate on a <tree> object but automatically dereferences |
| 378 | <commit> and <tag> objects that point at a <tree>. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 379 | |
Theodore Ts'o | 043d760 | 2007-03-05 14:46:05 -0500 | [diff] [blame] | 380 | <commit-ish>:: |
| 381 | Indicates a commit or tag object name. A |
| 382 | command that takes a <commit-ish> argument ultimately wants to |
| 383 | operate on a <commit> object but automatically dereferences |
| 384 | <tag> objects that point at a <commit>. |
| 385 | |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 386 | <type>:: |
| 387 | Indicates that an object type is required. |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 388 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 389 | |
| 390 | <file>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 391 | Indicates a filename - almost always relative to the |
| 392 | root of the tree structure `GIT_INDEX_FILE` describes. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 393 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 394 | Symbolic Identifiers |
| 395 | -------------------- |
Yasushi SHOJI | 90933ef | 2005-08-16 00:23:06 +0900 | [diff] [blame] | 396 | Any git command accepting any <object> can also use the following |
David Greaves | 6c84e2e | 2005-05-22 18:44:16 +0100 | [diff] [blame] | 397 | symbolic notation: |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 398 | |
| 399 | HEAD:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 400 | indicates the head of the current branch (i.e. the |
| 401 | contents of `$GIT_DIR/HEAD`). |
| 402 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 403 | <tag>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 404 | a valid tag 'name' |
| 405 | (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). |
| 406 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 407 | <head>:: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 408 | a valid head 'name' |
| 409 | (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). |
| 410 | |
Junio C Hamano | d47107d | 2006-10-25 11:33:08 -0700 | [diff] [blame] | 411 | For a more complete list of ways to spell object names, see |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 412 | "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. |
Junio C Hamano | d47107d | 2006-10-25 11:33:08 -0700 | [diff] [blame] | 413 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 414 | |
| 415 | File/Directory Structure |
| 416 | ------------------------ |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 417 | |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 418 | Please see the linkgit:gitrepository-layout[5] document. |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 419 | |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 420 | Read linkgit:githooks[5] for more details about each hook. |
Jon Loeliger | 6250ad1 | 2006-03-24 21:21:07 -0600 | [diff] [blame] | 421 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 422 | Higher level SCMs may provide and manage additional information in the |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 423 | `$GIT_DIR`. |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 424 | |
Junio C Hamano | a1d4aa7 | 2005-09-01 16:56:13 -0700 | [diff] [blame] | 425 | |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 426 | Terminology |
| 427 | ----------- |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 428 | Please see linkgit:gitglossary[7]. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 429 | |
| 430 | |
| 431 | Environment Variables |
| 432 | --------------------- |
| 433 | Various git commands use the following environment variables: |
| 434 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 435 | The git Repository |
| 436 | ~~~~~~~~~~~~~~~~~~ |
| 437 | These environment variables apply to 'all' core git commands. Nb: it |
| 438 | is worth noting that they may be used/overridden by SCMS sitting above |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 439 | git so take care if using Cogito etc. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 440 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 441 | 'GIT_INDEX_FILE':: |
| 442 | This environment allows the specification of an alternate |
Lukas_Sandström | 5f3aa19 | 2005-11-11 02:12:27 +0100 | [diff] [blame] | 443 | index file. If not specified, the default of `$GIT_DIR/index` |
| 444 | is used. |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 445 | |
| 446 | 'GIT_OBJECT_DIRECTORY':: |
| 447 | If the object storage directory is specified via this |
| 448 | environment variable then the sha1 directories are created |
| 449 | underneath - otherwise the default `$GIT_DIR/objects` |
| 450 | directory is used. |
| 451 | |
| 452 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: |
| 453 | Due to the immutable nature of git objects, old objects can be |
| 454 | archived into shared, read-only directories. This variable |
Johannes Sixt | 80ba074 | 2007-12-03 21:55:57 +0100 | [diff] [blame] | 455 | specifies a ":" separated (on Windows ";" separated) list |
| 456 | of git object directories which can be used to search for git |
| 457 | objects. New objects will not be written to these directories. |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 458 | |
| 459 | 'GIT_DIR':: |
Junio C Hamano | 2fa090b | 2005-12-07 16:05:21 -0800 | [diff] [blame] | 460 | If the 'GIT_DIR' environment variable is set then it |
| 461 | specifies a path to use instead of the default `.git` |
| 462 | for the base of the repository. |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 463 | |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 464 | 'GIT_WORK_TREE':: |
| 465 | Set the path to the working tree. The value will not be |
| 466 | used in combination with repositories found automatically in |
| 467 | a .git directory (i.e. $GIT_DIR is not set). |
| 468 | This can also be controlled by the '--work-tree' command line |
| 469 | option and the core.worktree configuration variable. |
| 470 | |
David Reiss | 0454dd9 | 2008-05-19 23:49:26 -0700 | [diff] [blame] | 471 | 'GIT_CEILING_DIRECTORIES':: |
| 472 | This should be a colon-separated list of absolute paths. |
| 473 | If set, it is a list of directories that git should not chdir |
| 474 | up into while looking for a repository directory. |
| 475 | It will not exclude the current working directory or |
| 476 | a GIT_DIR set on the command line or in the environment. |
| 477 | (Useful for excluding slow-loading network directories.) |
| 478 | |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 479 | git Commits |
| 480 | ~~~~~~~~~~~ |
| 481 | 'GIT_AUTHOR_NAME':: |
| 482 | 'GIT_AUTHOR_EMAIL':: |
| 483 | 'GIT_AUTHOR_DATE':: |
| 484 | 'GIT_COMMITTER_NAME':: |
| 485 | 'GIT_COMMITTER_EMAIL':: |
Josh Triplett | 4e58bf9 | 2007-04-28 18:40:12 -0700 | [diff] [blame] | 486 | 'GIT_COMMITTER_DATE':: |
Josh Triplett | 28a94f8 | 2007-04-28 18:40:28 -0700 | [diff] [blame] | 487 | 'EMAIL':: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 488 | see linkgit:git-commit-tree[1] |
David Greaves | c1bdacf | 2005-05-10 22:32:38 +0100 | [diff] [blame] | 489 | |
| 490 | git Diffs |
| 491 | ~~~~~~~~~ |
Junio C Hamano | d81ed1b | 2005-05-10 20:54:57 -0700 | [diff] [blame] | 492 | 'GIT_DIFF_OPTS':: |
Sean | fde97d8 | 2006-11-27 14:37:43 -0500 | [diff] [blame] | 493 | Only valid setting is "--unified=??" or "-u??" to set the |
| 494 | number of context lines shown when a unified diff is created. |
| 495 | This takes precedence over any "-U" or "--unified" option |
| 496 | value passed on the git diff command line. |
| 497 | |
Junio C Hamano | d81ed1b | 2005-05-10 20:54:57 -0700 | [diff] [blame] | 498 | 'GIT_EXTERNAL_DIFF':: |
Sean | fde97d8 | 2006-11-27 14:37:43 -0500 | [diff] [blame] | 499 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
| 500 | program named by it is called, instead of the diff invocation |
| 501 | described above. For a path that is added, removed, or modified, |
| 502 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: |
| 503 | |
| 504 | path old-file old-hex old-mode new-file new-hex new-mode |
| 505 | + |
| 506 | where: |
| 507 | |
| 508 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the |
| 509 | contents of <old|new>, |
| 510 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, |
| 511 | <old|new>-mode:: are the octal representation of the file modes. |
| 512 | |
| 513 | + |
| 514 | The file parameters can point at the user's working file |
| 515 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` |
| 516 | when a new file is added), or a temporary file (e.g. `old-file` in the |
| 517 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the |
| 518 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. |
| 519 | + |
| 520 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 |
| 521 | parameter, <path>. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 522 | |
Matthias Lederhofer | 575ba9d | 2006-06-25 15:56:18 +0200 | [diff] [blame] | 523 | other |
| 524 | ~~~~~ |
Jakub Narebski | dbddb71 | 2007-07-13 01:54:06 +0200 | [diff] [blame] | 525 | 'GIT_MERGE_VERBOSITY':: |
| 526 | A number controlling the amount of output shown by |
| 527 | the recursive merge strategy. Overrides merge.verbosity. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 528 | See linkgit:git-merge[1] |
Jakub Narebski | dbddb71 | 2007-07-13 01:54:06 +0200 | [diff] [blame] | 529 | |
Matthias Lederhofer | c27d205 | 2006-07-31 15:27:00 +0200 | [diff] [blame] | 530 | 'GIT_PAGER':: |
Steven Grimm | a7738c7 | 2007-07-19 03:43:51 -0700 | [diff] [blame] | 531 | This environment variable overrides `$PAGER`. If it is set |
| 532 | to an empty string or to the value "cat", git will not launch |
Jonathan Nieder | ab54cd6 | 2008-08-24 00:28:32 -0500 | [diff] [blame] | 533 | a pager. See also the `core.pager` option in |
| 534 | linkgit:git-config[1]. |
Matthias Lederhofer | c27d205 | 2006-07-31 15:27:00 +0200 | [diff] [blame] | 535 | |
Shawn O. Pearce | d5538b4 | 2007-08-04 02:06:52 -0400 | [diff] [blame] | 536 | 'GIT_SSH':: |
Jonathan Nieder | ba020ef | 2008-07-03 00:41:41 -0500 | [diff] [blame] | 537 | If this environment variable is set then 'git-fetch' |
| 538 | and 'git-push' will use this command instead |
Jonathan Nieder | 2fd02c9 | 2008-07-03 00:55:07 -0500 | [diff] [blame] | 539 | of 'ssh' when they need to connect to a remote system. |
Jonathan Nieder | 483bc4f | 2008-06-30 13:56:34 -0500 | [diff] [blame] | 540 | The '$GIT_SSH' command will be given exactly two arguments: |
Shawn O. Pearce | d5538b4 | 2007-08-04 02:06:52 -0400 | [diff] [blame] | 541 | the 'username@host' (or just 'host') from the URL and the |
| 542 | shell command to execute on that remote system. |
| 543 | + |
| 544 | To pass options to the program that you want to list in GIT_SSH |
| 545 | you will need to wrap the program and options into a shell script, |
| 546 | then set GIT_SSH to refer to the shell script. |
| 547 | + |
| 548 | Usually it is easier to configure any desired options through your |
| 549 | personal `.ssh/config` file. Please consult your ssh documentation |
| 550 | for further details. |
| 551 | |
Theodore Ts'o | 06f59e9 | 2007-06-29 13:40:46 -0400 | [diff] [blame] | 552 | 'GIT_FLUSH':: |
| 553 | If this environment variable is set to "1", then commands such |
Jonathan Nieder | ba020ef | 2008-07-03 00:41:41 -0500 | [diff] [blame] | 554 | as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log', |
| 555 | and 'git-whatchanged' will force a flush of the output stream |
Theodore Ts'o | 06f59e9 | 2007-06-29 13:40:46 -0400 | [diff] [blame] | 556 | after each commit-oriented record have been flushed. If this |
| 557 | variable is set to "0", the output of these commands will be done |
| 558 | using completely buffered I/O. If this environment variable is |
| 559 | not set, git will choose buffered or record-oriented flushing |
| 560 | based on whether stdout appears to be redirected to a file or not. |
| 561 | |
Matthias Lederhofer | 575ba9d | 2006-06-25 15:56:18 +0200 | [diff] [blame] | 562 | 'GIT_TRACE':: |
Christian Couder | 2886bdb | 2006-09-03 17:32:24 +0200 | [diff] [blame] | 563 | If this variable is set to "1", "2" or "true" (comparison |
| 564 | is case insensitive), git will print `trace:` messages on |
Matthias Lederhofer | 575ba9d | 2006-06-25 15:56:18 +0200 | [diff] [blame] | 565 | stderr telling about alias expansion, built-in command |
| 566 | execution and external command execution. |
Christian Couder | 2886bdb | 2006-09-03 17:32:24 +0200 | [diff] [blame] | 567 | If this variable is set to an integer value greater than 1 |
| 568 | and lower than 10 (strictly) then git will interpret this |
| 569 | value as an open file descriptor and will try to write the |
| 570 | trace messages into this file descriptor. |
| 571 | Alternatively, if this variable is set to an absolute path |
| 572 | (starting with a '/' character), git will interpret this |
| 573 | as a file path and will try to write the trace messages |
| 574 | into it. |
Matthias Lederhofer | 575ba9d | 2006-06-25 15:56:18 +0200 | [diff] [blame] | 575 | |
Junio C Hamano | 8db9307 | 2005-08-30 13:51:01 -0700 | [diff] [blame] | 576 | Discussion[[Discussion]] |
| 577 | ------------------------ |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 578 | |
| 579 | More detail on the following is available from the |
| 580 | link:user-manual.html#git-concepts[git concepts chapter of the |
Jonathan Nieder | 6998e4d | 2008-06-30 17:01:21 -0500 | [diff] [blame] | 581 | user-manual] and linkgit:gitcore-tutorial[7]. |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 582 | |
| 583 | A git project normally consists of a working directory with a ".git" |
| 584 | subdirectory at the top level. The .git directory contains, among other |
| 585 | things, a compressed object database representing the complete history |
| 586 | of the project, an "index" file which links that history to the current |
| 587 | contents of the working tree, and named pointers into that history such |
| 588 | as tags and branch heads. |
| 589 | |
| 590 | The object database contains objects of three main types: blobs, which |
| 591 | hold file data; trees, which point to blobs and other trees to build up |
Ralf Wildenhues | 02ff625 | 2007-12-18 07:07:36 +0100 | [diff] [blame] | 592 | directory hierarchies; and commits, which each reference a single tree |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 593 | and some number of parent commits. |
| 594 | |
| 595 | The commit, equivalent to what other systems call a "changeset" or |
| 596 | "version", represents a step in the project's history, and each parent |
| 597 | represents an immediately preceding step. Commits with more than one |
| 598 | parent represent merges of independent lines of development. |
| 599 | |
| 600 | All objects are named by the SHA1 hash of their contents, normally |
| 601 | written as a string of 40 hex digits. Such names are globally unique. |
| 602 | The entire history leading up to a commit can be vouched for by signing |
| 603 | just that commit. A fourth object type, the tag, is provided for this |
| 604 | purpose. |
| 605 | |
| 606 | When first created, objects are stored in individual files, but for |
| 607 | efficiency may later be compressed together into "pack files". |
| 608 | |
| 609 | Named pointers called refs mark interesting points in history. A ref |
| 610 | may contain the SHA1 name of an object or the name of another ref. Refs |
| 611 | with names beginning `ref/head/` contain the SHA1 name of the most |
Ralf Wildenhues | 02ff625 | 2007-12-18 07:07:36 +0100 | [diff] [blame] | 612 | recent commit (or "head") of a branch under development. SHA1 names of |
J. Bruce Fields | 40dac51 | 2007-09-03 00:01:19 -0400 | [diff] [blame] | 613 | tags of interest are stored under `ref/tags/`. A special ref named |
| 614 | `HEAD` contains the name of the currently checked-out branch. |
| 615 | |
| 616 | The index file is initialized with a list of all paths and, for each |
| 617 | path, a blob object and a set of attributes. The blob object represents |
| 618 | the contents of the file as of the head of the current branch. The |
| 619 | attributes (last modified time, size, etc.) are taken from the |
| 620 | corresponding file in the working tree. Subsequent changes to the |
| 621 | working tree can be found by comparing these attributes. The index may |
| 622 | be updated with new content, and new commits may be created from the |
| 623 | content stored in the index. |
| 624 | |
| 625 | The index is also capable of storing multiple entries (called "stages") |
| 626 | for a given pathname. These stages are used to hold the various |
| 627 | unmerged version of a file when a merge is in progress. |
David Greaves | 6c84e2e | 2005-05-22 18:44:16 +0100 | [diff] [blame] | 628 | |
Andreas Ericsson | cb22bc4 | 2005-11-16 00:31:25 +0100 | [diff] [blame] | 629 | Authors |
| 630 | ------- |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 631 | * git's founding father is Linus Torvalds <torvalds@osdl.org>. |
Junio C Hamano | 947ad2e | 2007-09-01 04:09:51 -0700 | [diff] [blame] | 632 | * The current git nurse is Junio C Hamano <gitster@pobox.com>. |
Junio C Hamano | 0240e21 | 2007-12-04 00:47:04 -0800 | [diff] [blame] | 633 | * The git potty was written by Andreas Ericsson <ae@op5.se>. |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 634 | * General upbringing is handled by the git-list <git@vger.kernel.org>. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 635 | |
| 636 | Documentation |
| 637 | -------------- |
Junio C Hamano | 9755afb | 2005-12-13 02:38:24 -0800 | [diff] [blame] | 638 | The documentation for git suite was started by David Greaves |
| 639 | <david@dgreaves.com>, and later enhanced greatly by the |
| 640 | contributors on the git-list <git@vger.kernel.org>. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 641 | |
Christian Couder | 497c833 | 2008-05-29 19:21:46 +0200 | [diff] [blame] | 642 | SEE ALSO |
| 643 | -------- |
| 644 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], |
Jon Jensen | 5cbef01 | 2008-08-02 15:41:48 -0600 | [diff] [blame] | 645 | link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7], |
Christian Couder | 497c833 | 2008-05-29 19:21:46 +0200 | [diff] [blame] | 646 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
Brian Gernhardt | dc49308 | 2008-07-02 10:13:35 -0400 | [diff] [blame] | 647 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual] |
Christian Couder | 497c833 | 2008-05-29 19:21:46 +0200 | [diff] [blame] | 648 | |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 649 | GIT |
| 650 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 651 | Part of the linkgit:git[1] suite |