Documentation/git-commit: clarify that --only/--include records the working tree contents
authorJunio C Hamano <gitster@pobox.com>
Fri, 7 Nov 2014 19:55:40 +0000 (11:55 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 7 Nov 2014 19:57:57 +0000 (11:57 -0800)
With the original phrasing, it is possible to misunderstand as if
the contents in the index for only the specified paths are made into
the new commit.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-commit.txt
index 5cc84a139133dca2fdcb594007c8b0d6464d5ca8..a157c6883aecd14008292385fd8c809885cd261e 100644 (file)
@@ -211,9 +211,10 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
 
 -o::
 --only::
-       Make a commit only from the paths specified on the
+       Make a commit by taking the updated working tree contents
+       of the paths specified on the
        command line, disregarding any contents that have been
-       staged so far. This is the default mode of operation of
+       staged for other paths. This is the default mode of operation of
        'git commit' if any paths are given on the command line,
        in which case this option can be omitted.
        If this option is specified together with '--amend', then