summaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorStephan Beyer <s-beyer@gmx.net>2008-06-07 11:06:45 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-06-08 20:46:37 (GMT)
commitc4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a (patch)
treef1ba11025fcecd526c8c9ecbe662acf2fcd5cf4c /Documentation/git-commit.txt
parent88b1f0b8094638b1f9533393d1436d8c51fd07d5 (diff)
downloadgit-c4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a.zip
git-c4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a.tar.gz
git-c4a7ff52bda5c2e4cd08074ce4c27dbc0fc5242a.tar.bz2
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.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 02d4baa..40bf63e 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.