aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-reset.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-reset.adoc
parented260220948595b1311d4639dbfc20f02c807fac (diff)
downloadgit-03a353bb9759a1c775ba70f1e9ee865fc38291c2.tar.xz
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-reset.adoc')
-rw-r--r--Documentation/git-reset.adoc3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-reset.adoc b/Documentation/git-reset.adoc
index 50e8a0ba6f..3b9ba9aee9 100644
--- a/Documentation/git-reset.adoc
+++ b/Documentation/git-reset.adoc
@@ -90,7 +90,8 @@ but carries forward unmerged index entries.
If a file that is different between _<commit>_ and `HEAD` has local
changes, reset is aborted.
-`--[no-]recurse-submodules`::
+`--recurse-submodules`::
+`--no-recurse-submodules`::
When the working tree is updated, using `--recurse-submodules` will
also recursively reset the working tree of all active submodules
according to the commit recorded in the superproject, also setting