aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-commit.adoc
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2025-08-11 20:53:18 +0000
committerJunio C Hamano <gitster@pobox.com>2025-08-11 14:16:04 -0700
commit03a353bb9759a1c775ba70f1e9ee865fc38291c2 (patch)
treebb55e2ce67fd0d0c0056f89365eb25883b2ef29e /Documentation/git-commit.adoc
parentdoc: check for absence of multiple terms in each entry of desc list (diff)
downloadgit-03a353bb9759a1c775ba70f1e9ee865fc38291c2.tar.gz
git-03a353bb9759a1c775ba70f1e9ee865fc38291c2.zip
doc: check for absence of the form --[no-]parameter
For better searchability, this commit adds a check to ensure that parameters expressed in the form of `--[no-]parameter` are not used in the documentation. In the place of such parameters, the documentation should list two separate parameters: `--parameter` and `--no-parameter`. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit.adoc')
-rw-r--r--Documentation/git-commit.adoc3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc
index d4d576ce66..54c207ad45 100644
--- a/Documentation/git-commit.adoc
+++ b/Documentation/git-commit.adoc
@@ -214,7 +214,8 @@ include::signoff-option.adoc[]
each trailer would appear, and other details.
`-n`::
-`--[no-]verify`::
+`--verify`::
+`--no-verify`::
Bypass the `pre-commit` and `commit-msg` hooks.
See also linkgit:githooks[5].