summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Duy Nguyen <pclouds@gmail.com>2016-10-05 17:26:33 +0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2016-10-05 10:17:40 -0700
commit7431596ab1f05a13adb93b44108f27cfd6578a31 (patch)
tree2a4212f4e5179de5ae4ef4f453ef789cba3038a8
parentGit 2.8.4 (diff)
downloadtgif-7431596ab1f05a13adb93b44108f27cfd6578a31.tar.xz
git-commit.txt: clarify --patch mode with pathspec
How pathspec is used, with and without --interactive/--patch, is different. But this is not clear from the document. These changes hint the user to keep reading (to option #5) instead of stopping at #2 and assuming --patch/--interactive behaves the same way. And since all the options listed here always mention how the index is involved (or not) in the final commit, add that bit for #5 as well. This "on top of the index" is implied when you head over git-add(1), but if you just go straight to the "Interactive mode" and not read what git-add is for, you may miss it. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-commit.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 9ec6b3cc17..ac219e9b59 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -29,7 +29,8 @@ The content to be added can be specified in several ways:
2. by using 'git rm' to remove files from the working tree
and the index, again before using the 'commit' command;
-3. by listing files as arguments to the 'commit' command, in which
+3. by listing files as arguments to the 'commit' command
+ (without --interactive or --patch switch), in which
case the commit will ignore changes staged in the index, and instead
record the current content of the listed files (which must already
be known to Git);
@@ -41,7 +42,8 @@ The content to be added can be specified in several ways:
actual commit;
5. by using the --interactive or --patch switches with the 'commit' command
- to decide one by one which files or hunks should be part of the commit,
+ to decide one by one which files or hunks should be part of the commit
+ in addition to contents in the index,
before finalizing the operation. See the ``Interactive Mode'' section of
linkgit:git-add[1] to learn how to operate these modes.