diff options
| author | Stephan Beyer <s-beyer@gmx.net> | 2008-06-07 13:06:45 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-06-08 13:46:37 -0700 |
| commit | c4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a (patch) | |
| tree | f1ba11025fcecd526c8c9ecbe662acf2fcd5cf4c /Documentation/git-commit.txt | |
| parent | 88b1f0b8094638b1f9533393d1436d8c51fd07d5 (diff) | |
| download | git-c4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-commit.txt')
| -rw-r--r-- | Documentation/git-commit.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 02d4baab6d..40bf63ea63 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -8,9 +8,9 @@ git-commit - Record changes to the repository 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 @@ -68,7 +68,7 @@ OPTIONS 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. |