Merge branch 'js/git-submodule-trailing-slash'

[git.git] / Documentation / git-commit.txt

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 77604d021603fa7002e416356ae197648093b69d..b5d81be7ecd60daa1a1d476441ca58e6b732d9ef 100644 (file)
--- 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:
 
 3. by listing files as arguments to the 'commit' command, in which
    case the commit will ignore changes staged in the index, and instead
 
 3. by listing files as arguments to the 'commit' command, in which
    case the commit will ignore changes staged in the index, and instead

-   record the current content of the listed files;
+   record the current content of the listed files (which must already
+   be known to git);

 
 4. by using the -a switch with the 'commit' command to automatically
    "add" changes from all known files (i.e. all files that are already
 
 4. by using the -a switch with the 'commit' command to automatically
    "add" changes from all known files (i.e. all files that are already


@@ -75,8 +76,10 @@ OPTIONS
        read the message from the standard input.
 
 --author=<author>::
        read the message from the standard input.
 
 --author=<author>::

-       Override the author name used in the commit.  Use
-       `A U Thor <author@example.com>` format.
+       Override the author name used in the commit.  You can use the
+       standard `A U Thor <author@example.com>` format.  Otherwise,
+       an existing commit that matches the given string and its author
+       name is used.

 
 -m <msg>::
 --message=<msg>::
 
 -m <msg>::
 --message=<msg>::


@@ -143,6 +146,10 @@ It is a rough equivalent for:
 ------
 but can be used to amend a merge commit.
 --
 ------
 but can be used to amend a merge commit.
 --

++
+You should understand the implications of rewriting history if you
+amend a commit that has already been published.  (See the "RECOVERING
+FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)

 
 -i::
 --include::
 
 -i::
 --include::


@@ -159,7 +166,7 @@ but can be used to amend a merge commit.
        '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
        '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

-       no paths need be specified, which can be used to amend
+       no paths need to be specified, which can be used to amend

        the last commit without committing changes that have
        already been staged.
 
        the last commit without committing changes that have
        already been staged.