Skip to content

Commit

Permalink
add: Clarify documentation of -A and -u
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Greg Price authored and Junio C Hamano committed Mar 7, 2013
1 parent 7799588 commit 5cae935
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions Documentation/git-add.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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::
Expand Down

0 comments on commit 5cae935

Please sign in to comment.