Documentation: improve "add", "pull" and "format-patch" examples
[git/dscho.git] / Documentation / git-add.txt
blob2eabbc8f7cf56040bb57c5f5ee3570c63fedc166
1 git-add(1)
2 ==========
4 NAME
5 ----
6 git-add - Add file contents to the index
8 SYNOPSIS
9 --------
10 [verse]
11 'git-add' [-n] [-v] [-f] [--interactive | -i] [--patch | -p] [-u] [--refresh]
12           [--] <filepattern>...
14 DESCRIPTION
15 -----------
16 This command adds the current content of new or modified files to the
17 index, thus staging that content for inclusion in the next commit.
19 The "index" holds a snapshot of the content of the working tree, and it
20 is this snapshot that is taken as the contents of the next commit.  Thus
21 after making any changes to the working directory, and before running
22 the commit command, you must use the 'add' command to add any new or
23 modified files to the index.
25 This command can be performed multiple times before a commit.  It only
26 adds the content of the specified file(s) at the time the add command is
27 run; if you want subsequent changes included in the next commit, then
28 you must run 'git add' again to add the new content to the index.
30 The 'git status' command can be used to obtain a summary of which
31 files have changes that are staged for the next commit.
33 The 'git add' command will not add ignored files by default.  If any
34 ignored files were explicitly specified on the command line, 'git add'
35 will fail with a list of ignored files.  Ignored files reached by
36 directory recursion or filename globbing performed by Git (quote your
37 globs before the shell) will be silently ignored.  The 'add' command can
38 be used to add ignored files with the `-f` (force) option.
40 Please see linkgit:git-commit[1] for alternative ways to add content to a
41 commit.
44 OPTIONS
45 -------
46 <filepattern>...::
47         Files to add content from.  Fileglobs (e.g. `*.c`) can
48         be given to add all matching files.  Also a
49         leading directory name (e.g. `dir` to add `dir/file1`
50         and `dir/file2`) can be given to add all files in the
51         directory, recursively.
53 -n, \--dry-run::
54         Don't actually add the file(s), just show if they exist.
56 -v, \--verbose::
57         Be verbose.
59 -f::
60         Allow adding otherwise ignored files.
62 -i, \--interactive::
63         Add modified contents in the working tree interactively to
64         the index. Optional path arguments may be supplied to limit
65         operation to a subset of the working tree. See ``Interactive
66         mode'' for details.
68 -p, \--patch::
69         Similar to Interactive mode but the initial command loop is
70         bypassed and the 'patch' subcommand is invoked using each of
71         the specified filepatterns before exiting.
73 -u::
74         Update only files that git already knows about. This is similar
75         to what "git commit -a" does in preparation for making a commit,
76         except that the update is limited to paths specified on the
77         command line. If no paths are specified, all tracked files in the
78         current directory and its subdirectories are updated.
80 \--refresh::
81         Don't add the file(s), but only refresh their stat()
82         information in the index.
84 \--::
85         This option can be used to separate command-line options from
86         the list of files, (useful when filenames might be mistaken
87         for command-line options).
90 Configuration
91 -------------
93 The optional configuration variable 'core.excludesfile' indicates a path to a
94 file containing patterns of file names to exclude from git-add, similar to
95 $GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to
96 those in info/exclude.  See link:repository-layout.html[repository layout].
99 EXAMPLES
100 --------
102 * Adds content from all `\*.txt` files under `Documentation` directory
103 and its subdirectories:
105 ------------
106 $ git add Documentation/\\*.txt
107 ------------
109 Note that the asterisk `\*` is quoted from the shell in this
110 example; this lets the command to include the files from
111 subdirectories of `Documentation/` directory.
113 * Considers adding content from all git-*.sh scripts:
115 ------------
116 $ git add git-*.sh
117 ------------
119 Because this example lets shell expand the asterisk (i.e. you are
120 listing the files explicitly), it does not consider
121 `subdir/git-foo.sh`.
123 Interactive mode
124 ----------------
125 When the command enters the interactive mode, it shows the
126 output of the 'status' subcommand, and then goes into its
127 interactive command loop.
129 The command loop shows the list of subcommands available, and
130 gives a prompt "What now> ".  In general, when the prompt ends
131 with a single '>', you can pick only one of the choices given
132 and type return, like this:
134 ------------
135     *** Commands ***
136       1: status       2: update       3: revert       4: add untracked
137       5: patch        6: diff         7: quit         8: help
138     What now> 1
139 ------------
141 You also could say "s" or "sta" or "status" above as long as the
142 choice is unique.
144 The main command loop has 6 subcommands (plus help and quit).
146 status::
148    This shows the change between HEAD and index (i.e. what will be
149    committed if you say "git commit"), and between index and
150    working tree files (i.e. what you could stage further before
151    "git commit" using "git-add") for each path.  A sample output
152    looks like this:
154 ------------
155               staged     unstaged path
156      1:       binary      nothing foo.png
157      2:     +403/-35        +1/-1 git-add--interactive.perl
158 ------------
160 It shows that foo.png has differences from HEAD (but that is
161 binary so line count cannot be shown) and there is no
162 difference between indexed copy and the working tree
163 version (if the working tree version were also different,
164 'binary' would have been shown in place of 'nothing').  The
165 other file, git-add--interactive.perl, has 403 lines added
166 and 35 lines deleted if you commit what is in the index, but
167 working tree file has further modifications (one addition and
168 one deletion).
170 update::
172    This shows the status information and gives prompt
173    "Update>>".  When the prompt ends with double '>>', you can
174    make more than one selection, concatenated with whitespace or
175    comma.  Also you can say ranges.  E.g. "2-5 7,9" to choose
176    2,3,4,5,7,9 from the list.  You can say '*' to choose
177    everything.
179 What you chose are then highlighted with '*',
180 like this:
182 ------------
183            staged     unstaged path
184   1:       binary      nothing foo.png
185 * 2:     +403/-35        +1/-1 git-add--interactive.perl
186 ------------
188 To remove selection, prefix the input with `-`
189 like this:
191 ------------
192 Update>> -2
193 ------------
195 After making the selection, answer with an empty line to stage the
196 contents of working tree files for selected paths in the index.
198 revert::
200   This has a very similar UI to 'update', and the staged
201   information for selected paths are reverted to that of the
202   HEAD version.  Reverting new paths makes them untracked.
204 add untracked::
206   This has a very similar UI to 'update' and
207   'revert', and lets you add untracked paths to the index.
209 patch::
211   This lets you choose one path out of 'status' like selection.
212   After choosing the path, it presents diff between the index
213   and the working tree file and asks you if you want to stage
214   the change of each hunk.  You can say:
216        y - stage this hunk
217        n - do not stage this hunk
218        a - stage this and all the remaining hunks in the file
219        d - do not stage this hunk nor any of the remaining hunks in the file
220        j - leave this hunk undecided, see next undecided hunk
221        J - leave this hunk undecided, see next hunk
222        k - leave this hunk undecided, see previous undecided hunk
223        K - leave this hunk undecided, see previous hunk
224        s - split the current hunk into smaller hunks
225        ? - print help
227 After deciding the fate for all hunks, if there is any hunk
228 that was chosen, the index is updated with the selected hunks.
230 diff::
232   This lets you review what will be committed (i.e. between
233   HEAD and index).
235 Bugs
236 ----
237 The interactive mode does not work with files whose names contain
238 characters that need C-quoting.  `core.quotepath` configuration can be
239 used to work this limitation around to some degree, but backslash,
240 double-quote and control characters will still have problems.
242 See Also
243 --------
244 linkgit:git-status[1]
245 linkgit:git-rm[1]
246 linkgit:git-reset[1]
247 linkgit:git-mv[1]
248 linkgit:git-commit[1]
249 linkgit:git-update-index[1]
251 Author
252 ------
253 Written by Linus Torvalds <torvalds@osdl.org>
255 Documentation
256 --------------
257 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
261 Part of the linkgit:git[7] suite