Teach --stdin option to "log" family

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

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 5cce3a379167845a7c47e37d42e6b43ca399fa6c..0578a40d841348b5ae484e1fe15ce637ecc4b830 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -8,7 +8,7 @@ git-commit - Record changes to the repository
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend]
+'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]

           [(-c | -C) <commit>] [-F <file> | -m <msg>]
           [--allow-empty] [--no-verify] [-e] [--author=<author>]
           [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
           [(-c | -C) <commit>] [-F <file> | -m <msg>]
           [--allow-empty] [--no-verify] [-e] [--author=<author>]
           [--cleanup=<mode>] [--] [[-i | -o ]<file>...]


@@ -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


@@ -41,10 +42,9 @@ The content to be added can be specified in several ways:
    by one which files should be part of the commit, before finalizing the
    operation.  Currently, this is done by invoking 'git-add --interactive'.
 
    by one which files should be part of the commit, before finalizing the
    operation.  Currently, this is done by invoking 'git-add --interactive'.
 

-The 'git-status' command can be used to obtain a
+The `--dry-run` option can be used to obtain a

 summary of what is included by any of the above for the next
 summary of what is included by any of the above for the next

-commit by giving the same set of parameters you would give to
-this command.
+commit by giving the same set of parameters (options and paths).

 
 If you make a commit and then find a mistake immediately after
 that, you can recover from it with 'git-reset'.
 
 If you make a commit and then find a mistake immediately after
 that, you can recover from it with 'git-reset'.


@@ -75,8 +75,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 +145,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::


@@ -191,6 +197,11 @@ specified.
 --quiet::
        Suppress commit summary message.
 
 --quiet::
        Suppress commit summary message.
 

+--dry-run::
+       Do not create a commit, but show a list of paths that are
+       to be committed, paths with local changes that will be left
+       uncommitted and paths that are untracked.
+

 \--::
        Do not interpret any more arguments as options.
 
 \--::
        Do not interpret any more arguments as options.