diff options
| author | Greg Price <price@MIT.EDU> | 2013-03-07 05:13:15 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-03-07 11:16:54 -0800 |
| commit | 5cae93566027c1d148c9f6625aed484a7096a980 (patch) | |
| tree | 47a2d09d49080a11c0feb5919554d600f25a8838 /Documentation/git-add.txt | |
| parent | 7799588faa2a8071da8ef047c87f9a1520fb8903 (diff) | |
| download | git-5cae93566027c1d148c9f6625aed484a7096a980.tar.gz | |
add: Clarify documentation of -A and -u
The documentation of '-A' and '-u' is very confusing for someone who
doesn't already know what they do. Describe them with fewer words and
clearer parallelism to each other and to the behavior of plain 'add'.
Also mention the default <pathspec> for '-A' as well as '-u', because
it applies to both.
Signed-off-by: Greg Price <price@mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-add.txt')
| -rw-r--r-- | Documentation/git-add.txt | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 388a2254f9..b0944e57d5 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -100,12 +100,9 @@ apply to the index. See EDITING PATCHES below. -u:: --update:: - Only match <pathspec> against already tracked files in - the index rather than the working tree. That means that it - will never stage new files, but that it will stage modified - new contents of tracked files and that it will remove files - from the index if the corresponding files in the working tree - have been removed. + Update the index just where it already has an entry matching + <pathspec>. This removes as well as modifies index entries to + match the working tree, but adds no new files. + If no <pathspec> is given, the current version of Git defaults to "."; in other words, update all tracked files in the current directory @@ -114,10 +111,15 @@ of Git, hence the form without <pathspec> should not be used. -A:: --all:: - Like `-u`, but match <pathspec> against files in the - working tree in addition to the index. That means that it - will find new files as well as staging modified content and - removing files that are no longer in the working tree. + Update the index not only where the working tree has a file + matching <pathspec> but also where the index already has an + entry. This adds, modifies, and removes index entries to + match the working tree. ++ +If no <pathspec> is given, the current version of Git defaults to +"."; in other words, update all files in the current directory +and its subdirectories. This default will change in a future version +of Git, hence the form without <pathspec> should not be used. -N:: --intent-to-add:: |