aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-submodule.adoc
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-08-25 14:22:01 -0700
committerJunio C Hamano <gitster@pobox.com>2025-08-25 14:22:02 -0700
commit0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397 (patch)
treed7c7205b2ae9788e006996be6f8074978f215507 /Documentation/git-submodule.adoc
parentMerge branch 'tc/diff-tree-max-depth' (diff)
parentdoc lint: check that synopsis manpages have synopsis inlines (diff)
downloadgit-0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397.tar.gz
git-0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397.zip
Merge branch 'ja/doc-lint-sections-and-synopsis'
Doc lint updates to encourage the newer and easier-to-use `synopsis` format, with fixes to a handful of existing uses. * ja/doc-lint-sections-and-synopsis: doc lint: check that synopsis manpages have synopsis inlines doc:git-for-each-ref: fix styling and typos doc: check for absence of the form --[no-]parameter doc: check for absence of multiple terms in each entry of desc list doc: check well-formedness of delimited sections doc: test linkgit macros for well-formedness
Diffstat (limited to 'Documentation/git-submodule.adoc')
-rw-r--r--Documentation/git-submodule.adoc6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-submodule.adoc b/Documentation/git-submodule.adoc
index 503c84a200..95beaee561 100644
--- a/Documentation/git-submodule.adoc
+++ b/Documentation/git-submodule.adoc
@@ -442,7 +442,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
@@ -454,7 +455,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.