]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-add(1) |
2 | ========== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
5f42ac92 | 6 | git-add - Add file contents to the index |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
480611d1 | 10 | [verse] |
b1889c36 | 11 | 'git add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p] |
c59cb03a | 12 | [--edit | -e] [--all | [--update | -u]] [--intent-to-add | -N] |
f0e5a4b7 | 13 | [--refresh] [--ignore-errors] [--ignore-missing] [--] |
d32805dc | 14 | [<pathspec>...] |
7fc9d69f JH |
15 | |
16 | DESCRIPTION | |
17 | ----------- | |
968d7072 BG |
18 | This command updates the index using the current content found in |
19 | the working tree, to prepare the content staged for the next commit. | |
20 | It typically adds the current content of existing paths as a whole, | |
21 | but with some options it can also be used to add content with | |
22 | only part of the changes made to the working tree files applied, or | |
23 | remove paths that do not exist in the working tree anymore. | |
5f42ac92 BF |
24 | |
25 | The "index" holds a snapshot of the content of the working tree, and it | |
26 | is this snapshot that is taken as the contents of the next commit. Thus | |
27 | after making any changes to the working directory, and before running | |
441947f6 | 28 | the commit command, you must use the `add` command to add any new or |
5f42ac92 BF |
29 | modified files to the index. |
30 | ||
31 | This command can be performed multiple times before a commit. It only | |
32 | adds the content of the specified file(s) at the time the add command is | |
33 | run; if you want subsequent changes included in the next commit, then | |
441947f6 | 34 | you must run `git add` again to add the new content to the index. |
5f42ac92 | 35 | |
441947f6 | 36 | The `git status` command can be used to obtain a summary of which |
5f42ac92 BF |
37 | files have changes that are staged for the next commit. |
38 | ||
441947f6 BG |
39 | The `git add` command will not add ignored files by default. If any |
40 | ignored files were explicitly specified on the command line, `git add` | |
d1d028ea | 41 | will fail with a list of ignored files. Ignored files reached by |
9d5fc59d | 42 | directory recursion or filename globbing performed by Git (quote your |
ca768288 | 43 | globs before the shell) will be silently ignored. The 'git add' command can |
9d5fc59d | 44 | be used to add ignored files with the `-f` (force) option. |
7fc9d69f | 45 | |
5162e697 | 46 | Please see linkgit:git-commit[1] for alternative ways to add content to a |
366bfcb6 NP |
47 | commit. |
48 | ||
49 | ||
7fc9d69f JH |
50 | OPTIONS |
51 | ------- | |
d32805dc | 52 | <pathspec>...:: |
e23ca9e1 JH |
53 | Files to add content from. Fileglobs (e.g. `*.c`) can |
54 | be given to add all matching files. Also a | |
55 | leading directory name (e.g. `dir` to add `dir/file1` | |
56 | and `dir/file2`) can be given to add all files in the | |
57 | directory, recursively. | |
7fc9d69f | 58 | |
3240240f SB |
59 | -n:: |
60 | --dry-run:: | |
108da0db JL |
61 | Don't actually add the file(s), just show if they exist and/or will |
62 | be ignored. | |
918db541 | 63 | |
3240240f SB |
64 | -v:: |
65 | --verbose:: | |
918db541 CS |
66 | Be verbose. |
67 | ||
6a1ad325 | 68 | -f:: |
69c61c4f | 69 | --force:: |
6a1ad325 JH |
70 | Allow adding otherwise ignored files. |
71 | ||
3240240f SB |
72 | -i:: |
73 | --interactive:: | |
6a5ad23d | 74 | Add modified contents in the working tree interactively to |
b63e9950 WC |
75 | the index. Optional path arguments may be supplied to limit |
76 | operation to a subset of the working tree. See ``Interactive | |
77 | mode'' for details. | |
78 | ||
3240240f SB |
79 | -p:: |
80 | --patch:: | |
5f2b1e67 JA |
81 | Interactively choose hunks of patch between the index and the |
82 | work tree and add them to the index. This gives the user a chance | |
83 | to review the difference before adding modified contents to the | |
84 | index. | |
46ada61e SB |
85 | + |
86 | This effectively runs `add --interactive`, but bypasses the | |
87 | initial command menu and directly jumps to the `patch` subcommand. | |
88 | See ``Interactive mode'' for details. | |
6a5ad23d | 89 | |
c59cb03a JS |
90 | -e, \--edit:: |
91 | Open the diff vs. the index in an editor and let the user | |
92 | edit it. After the editor was closed, adjust the hunk headers | |
93 | and apply the patch to the index. | |
94 | + | |
5df4d67d | 95 | The intent of this option is to pick and choose lines of the patch to |
0fe802d4 JK |
96 | apply, or even to modify the contents of lines to be staged. This can be |
97 | quicker and more flexible than using the interactive hunk selector. | |
98 | However, it is easy to confuse oneself and create a patch that does not | |
99 | apply to the index. See EDITING PATCHES below. | |
c59cb03a | 100 | |
bc3561f3 | 101 | -u:: |
69c61c4f | 102 | --update:: |
d32805dc | 103 | Only match <pathspec> against already tracked files in |
968d7072 BG |
104 | the index rather than the working tree. That means that it |
105 | will never stage new files, but that it will stage modified | |
106 | new contents of tracked files and that it will remove files | |
107 | from the index if the corresponding files in the working tree | |
108 | have been removed. | |
109 | + | |
d32805dc | 110 | If no <pathspec> is given, default to "."; in other words, |
968d7072 BG |
111 | update all tracked files in the current directory and its |
112 | subdirectories. | |
bc3561f3 | 113 | |
da98053a JH |
114 | -A:: |
115 | --all:: | |
d32805dc | 116 | Like `-u`, but match <pathspec> against files in the |
968d7072 BG |
117 | working tree in addition to the index. That means that it |
118 | will find new files as well as staging modified content and | |
119 | removing files that are no longer in the working tree. | |
8776f5d3 JK |
120 | |
121 | -N:: | |
122 | --intent-to-add:: | |
123 | Record only the fact that the path will be added later. An entry | |
124 | for the path is placed in the index with no content. This is | |
125 | useful for, among other things, showing the unstaged content of | |
441947f6 BG |
126 | such files with `git diff` and committing them with `git commit |
127 | -a`. | |
8776f5d3 | 128 | |
3240240f | 129 | --refresh:: |
d616813d AJ |
130 | Don't add the file(s), but only refresh their stat() |
131 | information in the index. | |
132 | ||
3240240f | 133 | --ignore-errors:: |
984b83ef AR |
134 | If some files could not be added because of errors indexing |
135 | them, do not abort the operation, but continue adding the | |
136 | others. The command shall still exit with non-zero status. | |
d0224436 VH |
137 | The configuration variable `add.ignoreErrors` can be set to |
138 | true to make this the default behaviour. | |
984b83ef | 139 | |
108da0db JL |
140 | --ignore-missing:: |
141 | This option can only be used together with --dry-run. By using | |
142 | this option the user can check if any of the given files would | |
143 | be ignored, no matter if they are already present in the work | |
144 | tree or not. | |
145 | ||
e994004f | 146 | \--:: |
60ace879 CW |
147 | This option can be used to separate command-line options from |
148 | the list of files, (useful when filenames might be mistaken | |
149 | for command-line options). | |
150 | ||
918db541 | 151 | |
164b1989 MH |
152 | Configuration |
153 | ------------- | |
154 | ||
441947f6 | 155 | The optional configuration variable `core.excludesfile` indicates a path to a |
164b1989 MH |
156 | file containing patterns of file names to exclude from git-add, similar to |
157 | $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to | |
a73d3790 | 158 | those in info/exclude. See linkgit:gitignore[5]. |
164b1989 MH |
159 | |
160 | ||
810bf1f9 JH |
161 | EXAMPLES |
162 | -------- | |
810bf1f9 | 163 | |
1b6c6cf0 | 164 | * Adds content from all `*.txt` files under `Documentation` directory |
921177f5 CC |
165 | and its subdirectories: |
166 | + | |
167 | ------------ | |
bf7cbb2f | 168 | $ git add Documentation/\*.txt |
921177f5 | 169 | ------------ |
810bf1f9 | 170 | + |
1b6c6cf0 | 171 | Note that the asterisk `*` is quoted from the shell in this |
dcc901bc | 172 | example; this lets the command include the files from |
810bf1f9 JH |
173 | subdirectories of `Documentation/` directory. |
174 | ||
921177f5 CC |
175 | * Considers adding content from all git-*.sh scripts: |
176 | + | |
177 | ------------ | |
178 | $ git add git-*.sh | |
179 | ------------ | |
180 | + | |
dcc901bc | 181 | Because this example lets the shell expand the asterisk (i.e. you are |
921177f5 CC |
182 | listing the files explicitly), it does not consider |
183 | `subdir/git-foo.sh`. | |
810bf1f9 | 184 | |
6a5ad23d JH |
185 | Interactive mode |
186 | ---------------- | |
187 | When the command enters the interactive mode, it shows the | |
23bfbb81 | 188 | output of the 'status' subcommand, and then goes into its |
6a5ad23d JH |
189 | interactive command loop. |
190 | ||
191 | The command loop shows the list of subcommands available, and | |
192 | gives a prompt "What now> ". In general, when the prompt ends | |
193 | with a single '>', you can pick only one of the choices given | |
194 | and type return, like this: | |
195 | ||
196 | ------------ | |
197 | *** Commands *** | |
198 | 1: status 2: update 3: revert 4: add untracked | |
199 | 5: patch 6: diff 7: quit 8: help | |
200 | What now> 1 | |
201 | ------------ | |
202 | ||
441947f6 | 203 | You also could say `s` or `sta` or `status` above as long as the |
6a5ad23d JH |
204 | choice is unique. |
205 | ||
206 | The main command loop has 6 subcommands (plus help and quit). | |
207 | ||
208 | status:: | |
209 | ||
210 | This shows the change between HEAD and index (i.e. what will be | |
441947f6 | 211 | committed if you say `git commit`), and between index and |
6a5ad23d | 212 | working tree files (i.e. what you could stage further before |
441947f6 | 213 | `git commit` using `git add`) for each path. A sample output |
6a5ad23d JH |
214 | looks like this: |
215 | + | |
216 | ------------ | |
217 | staged unstaged path | |
218 | 1: binary nothing foo.png | |
219 | 2: +403/-35 +1/-1 git-add--interactive.perl | |
220 | ------------ | |
221 | + | |
222 | It shows that foo.png has differences from HEAD (but that is | |
223 | binary so line count cannot be shown) and there is no | |
224 | difference between indexed copy and the working tree | |
225 | version (if the working tree version were also different, | |
226 | 'binary' would have been shown in place of 'nothing'). The | |
28394787 | 227 | other file, git-add{litdd}interactive.perl, has 403 lines added |
6a5ad23d JH |
228 | and 35 lines deleted if you commit what is in the index, but |
229 | working tree file has further modifications (one addition and | |
230 | one deletion). | |
231 | ||
232 | update:: | |
233 | ||
dcc901bc DM |
234 | This shows the status information and issues an "Update>>" |
235 | prompt. When the prompt ends with double '>>', you can | |
6a5ad23d JH |
236 | make more than one selection, concatenated with whitespace or |
237 | comma. Also you can say ranges. E.g. "2-5 7,9" to choose | |
1e5aaa6d CM |
238 | 2,3,4,5,7,9 from the list. If the second number in a range is |
239 | omitted, all remaining patches are taken. E.g. "7-" to choose | |
240 | 7,8,9 from the list. You can say '*' to choose everything. | |
6a5ad23d JH |
241 | + |
242 | What you chose are then highlighted with '*', | |
243 | like this: | |
244 | + | |
245 | ------------ | |
246 | staged unstaged path | |
247 | 1: binary nothing foo.png | |
248 | * 2: +403/-35 +1/-1 git-add--interactive.perl | |
249 | ------------ | |
250 | + | |
251 | To remove selection, prefix the input with `-` | |
252 | like this: | |
253 | + | |
254 | ------------ | |
255 | Update>> -2 | |
256 | ------------ | |
257 | + | |
258 | After making the selection, answer with an empty line to stage the | |
259 | contents of working tree files for selected paths in the index. | |
260 | ||
261 | revert:: | |
262 | ||
263 | This has a very similar UI to 'update', and the staged | |
264 | information for selected paths are reverted to that of the | |
265 | HEAD version. Reverting new paths makes them untracked. | |
266 | ||
267 | add untracked:: | |
268 | ||
269 | This has a very similar UI to 'update' and | |
270 | 'revert', and lets you add untracked paths to the index. | |
271 | ||
272 | patch:: | |
273 | ||
dcc901bc DM |
274 | This lets you choose one path out of a 'status' like selection. |
275 | After choosing the path, it presents the diff between the index | |
6a5ad23d | 276 | and the working tree file and asks you if you want to stage |
c105356e VH |
277 | the change of each hunk. You can select one of the following |
278 | options and type return: | |
6a5ad23d | 279 | |
bb12ac51 VK |
280 | y - stage this hunk |
281 | n - do not stage this hunk | |
74e42ce1 JN |
282 | q - quit; do not stage this hunk nor any of the remaining ones |
283 | a - stage this hunk and all later hunks in the file | |
284 | d - do not stage this hunk nor any of the later hunks in the file | |
595f6948 MM |
285 | g - select a hunk to go to |
286 | / - search for a hunk matching the given regex | |
bb12ac51 VK |
287 | j - leave this hunk undecided, see next undecided hunk |
288 | J - leave this hunk undecided, see next hunk | |
289 | k - leave this hunk undecided, see previous undecided hunk | |
290 | K - leave this hunk undecided, see previous hunk | |
280e50c7 | 291 | s - split the current hunk into smaller hunks |
ac083c47 | 292 | e - manually edit the current hunk |
280e50c7 | 293 | ? - print help |
6a5ad23d JH |
294 | + |
295 | After deciding the fate for all hunks, if there is any hunk | |
296 | that was chosen, the index is updated with the selected hunks. | |
c105356e VH |
297 | + |
298 | You can omit having to type return here, by setting the configuration | |
299 | variable `interactive.singlekey` to `true`. | |
6a5ad23d JH |
300 | |
301 | diff:: | |
302 | ||
303 | This lets you review what will be committed (i.e. between | |
304 | HEAD and index). | |
305 | ||
0fe802d4 JK |
306 | |
307 | EDITING PATCHES | |
308 | --------------- | |
309 | ||
310 | Invoking `git add -e` or selecting `e` from the interactive hunk | |
311 | selector will open a patch in your editor; after the editor exits, the | |
312 | result is applied to the index. You are free to make arbitrary changes | |
313 | to the patch, but note that some changes may have confusing results, or | |
314 | even result in a patch that cannot be applied. If you want to abort the | |
315 | operation entirely (i.e., stage nothing new in the index), simply delete | |
316 | all lines of the patch. The list below describes some common things you | |
317 | may see in a patch, and which editing operations make sense on them. | |
318 | ||
319 | -- | |
320 | added content:: | |
321 | ||
322 | Added content is represented by lines beginning with "{plus}". You can | |
323 | prevent staging any addition lines by deleting them. | |
324 | ||
325 | removed content:: | |
326 | ||
327 | Removed content is represented by lines beginning with "-". You can | |
328 | prevent staging their removal by converting the "-" to a " " (space). | |
329 | ||
330 | modified content:: | |
331 | ||
332 | Modified content is represented by "-" lines (removing the old content) | |
333 | followed by "{plus}" lines (adding the replacement content). You can | |
334 | prevent staging the modification by converting "-" lines to " ", and | |
335 | removing "{plus}" lines. Beware that modifying only half of the pair is | |
336 | likely to introduce confusing changes to the index. | |
337 | -- | |
338 | ||
339 | There are also more complex operations that can be performed. But beware | |
340 | that because the patch is applied only to the index and not the working | |
341 | tree, the working tree will appear to "undo" the change in the index. | |
469bfc96 | 342 | For example, introducing a new line into the index that is in neither |
0fe802d4 JK |
343 | the HEAD nor the working tree will stage the new line for commit, but |
344 | the line will appear to be reverted in the working tree. | |
345 | ||
346 | Avoid using these constructs, or do so with extreme caution. | |
347 | ||
348 | -- | |
349 | removing untouched content:: | |
350 | ||
351 | Content which does not differ between the index and working tree may be | |
352 | shown on context lines, beginning with a " " (space). You can stage | |
353 | context lines for removal by converting the space to a "-". The | |
354 | resulting working tree file will appear to re-add the content. | |
355 | ||
356 | modifying existing content:: | |
357 | ||
358 | One can also modify context lines by staging them for removal (by | |
359 | converting " " to "-") and adding a "{plus}" line with the new content. | |
360 | Similarly, one can modify "{plus}" lines for existing additions or | |
361 | modifications. In all cases, the new modification will appear reverted | |
362 | in the working tree. | |
363 | ||
364 | new content:: | |
365 | ||
366 | You may also add new content that does not exist in the patch; simply | |
367 | add new lines, each starting with "{plus}". The addition will appear | |
368 | reverted in the working tree. | |
369 | -- | |
370 | ||
371 | There are also several operations which should be avoided entirely, as | |
372 | they will make the patch impossible to apply: | |
373 | ||
374 | * adding context (" ") or removal ("-") lines | |
375 | * deleting context or removal lines | |
376 | * modifying the contents of context or removal lines | |
377 | ||
56ae8df5 | 378 | SEE ALSO |
872d001f | 379 | -------- |
5162e697 DM |
380 | linkgit:git-status[1] |
381 | linkgit:git-rm[1] | |
382 | linkgit:git-reset[1] | |
383 | linkgit:git-mv[1] | |
384 | linkgit:git-commit[1] | |
385 | linkgit:git-update-index[1] | |
810bf1f9 | 386 | |
7fc9d69f JH |
387 | GIT |
388 | --- | |
9e1f0a85 | 389 | Part of the linkgit:git[1] suite |