git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] git-commit.txt: Correct option alternatives

From
Stephan Beyer <s-beyer@gmx.net>
Date
Jun 7, 2008, 11:06 UTC
Message-ID
<1212836805-20684-1-git-send-email-s-beyer@gmx.net>
In-Reply-To
<200806070534.45761.chriscool@tuxfamily.org>
This patch fixes the SYNOPSIS in git-commit.txt:
 * --amend is not an alternative option to -c/-C/-F/-m
 * -m and -F are not alternative options to -c/-C,
   because 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>
---
Thanks, Christian.
Sometimes I'm too blind.
 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 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.
 
-- 
1.5.5.1
Previous: Christian CouderNext: Jon Loeliger
Message 10 of 12 in “git-commit.txt: Correct option alternatives”
  1. 1/2 git-commit.txt: Correct option alternativesStephan Beyer, Jun 7, 2008
  2. 2/2 git-commit.txt: Add missing long/short optionsStephan Beyer, Jun 7, 2008
  3. Junio C HamanoJun 7, 2008
  4. 1/5 git-commit.txt: Add missing long/short optionsStephan Beyer, Jun 8, 2008
  5. 2/5 Docs: Use "-l::\n--long\n" format in OPTIONS sectionsStephan Beyer, Jun 8, 2008
  6. 3/5 Docs: add some long/short optionsStephan Beyer, Jun 8, 2008
  7. 4/5 git-describe.txt: document --alwaysStephan Beyer, Jun 8, 2008
  8. 5/5 git-name-rev.txt: document --no-undefined and --alwaysStephan Beyer, Jun 8, 2008
  9. Christian CouderJun 7, 2008
  10. git-commit.txt: Correct option alternativesStephan Beyer, Jun 7, 2008
  11. Jon LoeligerJun 8, 2008
  12. Jeff KingJun 8, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.