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

[PATCH 4/17] Documentation/git-commit.txt: Add long options and -- to documentation.

From
NWNikolai Weibull <mailing-lists.git@rawuncut.elitemail.org>
Date
Dec 8, 2005, 23:28 UTC
Message-ID
<11340844853670-git-send-email-mailing-lists.git@rawuncut.elitemail.org>
In-Reply-To
<11340844852030-git-send-email-mailing-lists.git@rawuncut.elitemail.org>
Added the following long options to documentation:
* --all
* --signoff
* --verify
* --no-verify
* --edit
Also added documentation for the -- option for terminating option parsing.
Signed-off-by: Nikolai Weibull <nikolai@bitwi.se>
---
 Documentation/git-commit.txt |   18 ++++++++++++------
 1 files changed, 12 insertions(+), 6 deletions(-)
f0cc0137f124e36fd31acb8d0d543bdc84923586
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 1edc278..b92cf48 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -7,7 +7,7 @@ git-commit - Record your changes
 
 SYNOPSIS
 --------
-'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...
+'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>...
 
 DESCRIPTION
 -----------
@@ -22,7 +22,7 @@ information.
 
 OPTIONS
 -------
--a::
+-a|--all::
 	Update all paths in the index file.
 
 -c or -C <commit>::
@@ -39,23 +39,29 @@ OPTIONS
 -m <msg>::
 	Use the given <msg> as the commit message.
 
--s::
+-s|--signoff::
 	Add Signed-off-by line at the end of the commit message.
 
--v::
+-v|--verify::
 	Look for suspicious lines the commit introduces, and
 	abort committing if there is one.  The definition of
 	'suspicious lines' is currently the lines that has
 	trailing whitespaces, and the lines whose indentation
 	has a SP character immediately followed by a TAB
-	character.
+	character.  This is the default.
 
--e::
+-n|--no-verify::
+	The opposite of `--verify`.
+
+-e|--edit::
 	The message taken from file with `-F`, command line with
 	`-m`, and from file with `-C` are usually used as the
 	commit log message unmodified.  This option lets you
 	further edit the message taken from these sources.
 
+--::
+	Do not interpret any more arguments as options.
+
 <file>...::
 	Update specified paths in the index file before committing.
 
-- 
0.99.9l
Next: Nikolai Weibull
Message 1 of 12 in “Documentation/git-commit.txt: Add long options and -- to documentation.”
  1. 4/17 Documentation/git-commit.txt: Add long options and -- to documentation.Nikolai Weibull, Dec 8, 2005
  2. 5/17 Documentation/git-verify-pack.txt: added documentation for --.Nikolai Weibull, Dec 8, 2005
  3. 6/17 Document the [<head>...] and -- arguments to git-prune.Nikolai Weibull, Dec 8, 2005
  4. 7/17 Documentation/git-cvsimport.txt: Fix a slight glitch in description heading.Nikolai Weibull, Dec 8, 2005
  5. 8/17 Documentation/git-cherry-pick: Add --replay and --no-commit.Nikolai Weibull, Dec 8, 2005
  6. Junio C HamanoDec 8, 2005
  7. Junio C HamanoDec 8, 2005
  8. Junio C HamanoDec 9, 2005
  9. git-prune: never lose objects reachable from our refs.Junio C Hamano, Dec 9, 2005
  10. Peter EriksenDec 9, 2005
  11. Junio C HamanoDec 9, 2005
  12. Nikolai WeibullDec 9, 2005

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.