Re: [PATCH 1/2] git-commit.txt: Correct option alternatives
From: Christian Couder <hidden>
Date: 2016-06-15 22:44:42
Le samedi 7 juin 2008, Stephan Beyer a écrit :
Furthermore, for long-option consistency --author <author> is changed to --author=<author>.
[...]
The second hunk is: --author <author> is advertised for historical reasons (I guess), but all the other long options with an argument are --long-opt=<arg>, e.g. --message=<msg> or --cleanup=<mode>. (Notice the equals sign.) Because parse_long_opt() accepts both, I changed this for consistency reasons.
[...]
quoted hunk ↗ jump to hunk
@@ -8,8 +8,8 @@ git-commit - Record changes to the repository SYNOPSIS -------- [verse] -'git-commit' [-a | --interactive] [-s] [-v] [-u] - [(-c | -C) <commit> | -F <file> | -m <msg> | --amend] +'git-commit' [-a | --interactive] [-s] [-v] [-u] [--amend] + [(-c | -C) <commit>] [-F <file> | -m <msg>] [--allow-empty] [--no-verify] [-e] [--author <author>]
In the above line there is still "[--author <author>]" without "=",
[--cleanup=<mode>] [--] [[-i | -o ]<file>...]
while in this line there is "[--cleanup=<mode>]" with "=". So I think that to be consistent, "[--author=<author>]" (with "=") should be used in the SYNOPSIS too.
quoted hunk ↗ jump to hunk
@@ -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.
Thanks, Christian.