git-commit.txt: Correct option alternatives

This patch fixes the SYNOPSIS in git-commit.txt:

* --amend could be used in conjunction with -c/-C/-F/-m;
it is not mutually exclusive with them.

* -m and -F are not alternative options to -c/-C;
you can reuse authorship from a commit (-c/-C)
but change the message (-m/-F).

Furthermore, for long-option consistency --author <author>
is changed to --author=<author>.

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 02d4baab6d2530f91a76c2c3111e6d47376ca8d8..40bf63ea632c90e10fb328c37c1d489aef8a0d5d 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -8,9 +8,9 @@ git-commit - Record changes to the repository
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-commit' [-a | --interactive] [-s] [-v] [-u]
-          [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
-          [--allow-empty] [--no-verify] [-e] [--author <author>]
+'git-commit' [-a | --interactive] [-s] [-v] [-u] [--amend]
+          [(-c | -C) <commit>] [-F <file> | -m <msg>]
+          [--allow-empty] [--no-verify] [-e] [--author=<author>]

           [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
 
 DESCRIPTION
           [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
 
 DESCRIPTION


@@ -68,7 +68,7 @@ OPTIONS
        Take the commit message from the given file.  Use '-' to
        read the message from the standard input.
 
        Take the commit message from the given file.  Use '-' to
        read the message from the standard input.
 

---author <author>::
+--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.  Use
        `A U Thor <author@example.com>` format.