Documentation / git-add.txton commit Merge branch 'maint' (ffcc952)
   1git-add(1)
   2==========
   3
   4NAME
   5----
   6git-add - Add file contents to the changeset to be committed next
   7
   8SYNOPSIS
   9--------
  10'git-add' [-n] [-v] [-f] [--interactive | -i] [-u] [--] <file>...
  11
  12DESCRIPTION
  13-----------
  14All the changed file contents to be committed together in a single set
  15of changes must be "added" with the 'add' command before using the
  16'commit' command.  This is not only for adding new files.  Even modified
  17files must be added to the set of changes about to be committed.
  18
  19This command can be performed multiple times before a commit. The added
  20content corresponds to the state of specified file(s) at the time the
  21'add' command is used. This means the 'commit' command will not consider
  22subsequent changes to already added content if it is not added again before
  23the commit.
  24
  25The 'git status' command can be used to obtain a summary of what is included
  26for the next commit.
  27
  28This command can be used to add ignored files with `-f` (force)
  29option, but they have to be
  30explicitly and exactly specified from the command line.  File globbing
  31and recursive behaviour do not add ignored files.
  32
  33Please see gitlink:git-commit[1] for alternative ways to add content to a
  34commit.
  35
  36
  37OPTIONS
  38-------
  39<file>...::
  40        Files to add content from.  Fileglobs (e.g. `*.c`) can
  41        be given to add all matching files.  Also a
  42        leading directory name (e.g. `dir` to add `dir/file1`
  43        and `dir/file2`) can be given to add all files in the
  44        directory, recursively.
  45
  46-n::
  47        Don't actually add the file(s), just show if they exist.
  48
  49-v::
  50        Be verbose.
  51
  52-f::
  53        Allow adding otherwise ignored files.
  54
  55-i, \--interactive::
  56        Add modified contents in the working tree interactively to
  57        the index.
  58
  59-u::
  60        Update all files that git already knows about. This is what
  61        "git commit -a" does in preparation for making a commit.
  62
  63\--::
  64        This option can be used to separate command-line options from
  65        the list of files, (useful when filenames might be mistaken
  66        for command-line options).
  67
  68
  69EXAMPLES
  70--------
  71git-add Documentation/\\*.txt::
  72
  73        Adds content from all `\*.txt` files under `Documentation`
  74        directory and its subdirectories.
  75+
  76Note that the asterisk `\*` is quoted from the shell in this
  77example; this lets the command to include the files from
  78subdirectories of `Documentation/` directory.
  79
  80git-add git-*.sh::
  81
  82        Considers adding content from all git-*.sh scripts.
  83        Because this example lets shell expand the asterisk
  84        (i.e. you are listing the files explicitly), it does not
  85        consider `subdir/git-foo.sh`.
  86
  87Interactive mode
  88----------------
  89When the command enters the interactive mode, it shows the
  90output of the 'status' subcommand, and then goes into its
  91interactive command loop.
  92
  93The command loop shows the list of subcommands available, and
  94gives a prompt "What now> ".  In general, when the prompt ends
  95with a single '>', you can pick only one of the choices given
  96and type return, like this:
  97
  98------------
  99    *** Commands ***
 100      1: status       2: update       3: revert       4: add untracked
 101      5: patch        6: diff         7: quit         8: help
 102    What now> 1
 103------------
 104
 105You also could say "s" or "sta" or "status" above as long as the
 106choice is unique.
 107
 108The main command loop has 6 subcommands (plus help and quit).
 109
 110status::
 111
 112   This shows the change between HEAD and index (i.e. what will be
 113   committed if you say "git commit"), and between index and
 114   working tree files (i.e. what you could stage further before
 115   "git commit" using "git-add") for each path.  A sample output
 116   looks like this:
 117+
 118------------
 119              staged     unstaged path
 120     1:       binary      nothing foo.png
 121     2:     +403/-35        +1/-1 git-add--interactive.perl
 122------------
 123+
 124It shows that foo.png has differences from HEAD (but that is
 125binary so line count cannot be shown) and there is no
 126difference between indexed copy and the working tree
 127version (if the working tree version were also different,
 128'binary' would have been shown in place of 'nothing').  The
 129other file, git-add--interactive.perl, has 403 lines added
 130and 35 lines deleted if you commit what is in the index, but
 131working tree file has further modifications (one addition and
 132one deletion).
 133
 134update::
 135
 136   This shows the status information and gives prompt
 137   "Update>>".  When the prompt ends with double '>>', you can
 138   make more than one selection, concatenated with whitespace or
 139   comma.  Also you can say ranges.  E.g. "2-5 7,9" to choose
 140   2,3,4,5,7,9 from the list.  You can say '*' to choose
 141   everything.
 142+
 143What you chose are then highlighted with '*',
 144like this:
 145+
 146------------
 147           staged     unstaged path
 148  1:       binary      nothing foo.png
 149* 2:     +403/-35        +1/-1 git-add--interactive.perl
 150------------
 151+
 152To remove selection, prefix the input with `-`
 153like this:
 154+
 155------------
 156Update>> -2
 157------------
 158+
 159After making the selection, answer with an empty line to stage the
 160contents of working tree files for selected paths in the index.
 161
 162revert::
 163
 164  This has a very similar UI to 'update', and the staged
 165  information for selected paths are reverted to that of the
 166  HEAD version.  Reverting new paths makes them untracked.
 167
 168add untracked::
 169
 170  This has a very similar UI to 'update' and
 171  'revert', and lets you add untracked paths to the index.
 172
 173patch::
 174
 175  This lets you choose one path out of 'status' like selection.
 176  After choosing the path, it presents diff between the index
 177  and the working tree file and asks you if you want to stage
 178  the change of each hunk.  You can say:
 179
 180       y - add the change from that hunk to index
 181       n - do not add the change from that hunk to index
 182       a - add the change from that hunk and all the rest to index
 183       d - do not the change from that hunk nor any of the rest to index
 184       j - do not decide on this hunk now, and view the next
 185           undecided hunk
 186       J - do not decide on this hunk now, and view the next hunk
 187       k - do not decide on this hunk now, and view the previous
 188           undecided hunk
 189       K - do not decide on this hunk now, and view the previous hunk
 190+
 191After deciding the fate for all hunks, if there is any hunk
 192that was chosen, the index is updated with the selected hunks.
 193
 194diff::
 195
 196  This lets you review what will be committed (i.e. between
 197  HEAD and index).
 198
 199
 200See Also
 201--------
 202gitlink:git-status[1]
 203gitlink:git-rm[1]
 204gitlink:git-mv[1]
 205gitlink:git-commit[1]
 206gitlink:git-update-index[1]
 207
 208Author
 209------
 210Written by Linus Torvalds <torvalds@osdl.org>
 211
 212Documentation
 213--------------
 214Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 215
 216GIT
 217---
 218Part of the gitlink:git[7] suite
 219