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