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