diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2025-08-11 20:53:18 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-08-11 14:16:04 -0700 |
| commit | 03a353bb9759a1c775ba70f1e9ee865fc38291c2 (patch) | |
| tree | bb55e2ce67fd0d0c0056f89365eb25883b2ef29e /Documentation/git-submodule.adoc | |
| parent | ed260220948595b1311d4639dbfc20f02c807fac (diff) | |
| download | git-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-submodule.adoc')
| -rw-r--r-- | Documentation/git-submodule.adoc | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-submodule.adoc b/Documentation/git-submodule.adoc index 87d8e0f0c5..2d6ac92ea4 100644 --- a/Documentation/git-submodule.adoc +++ b/Documentation/git-submodule.adoc @@ -435,7 +435,8 @@ options carefully. clone with a history truncated to the specified number of revisions. See linkgit:git-clone[1] ---[no-]recommend-shallow:: +--recommend-shallow:: +--no-recommend-shallow:: This option is only valid for the update command. The initial clone of a submodule will use the recommended `submodule.<name>.shallow` as provided by the `.gitmodules` file @@ -447,7 +448,8 @@ options carefully. Clone new submodules in parallel with as many jobs. Defaults to the `submodule.fetchJobs` option. ---[no-]single-branch:: +--single-branch:: +--no-single-branch:: This option is only valid for the update command. Clone only one branch during update: HEAD or one specified by --branch. |