diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-08-17 09:27:06 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-08-17 09:27:06 -0700 |
| commit | 413ff100cdac43f14cbdfd5d117d9400d5adc860 (patch) | |
| tree | 142849d7c587bcd612f25fea7ad41f8312895e81 /Documentation/git-clone.adoc | |
| parent | Merge branch 'ad/t1517-short-help-tests-fix' into next (diff) | |
| parent | doc lint: check that synopsis manpages have synopsis inlines (diff) | |
| download | git-413ff100cdac43f14cbdfd5d117d9400d5adc860.tar.gz git-413ff100cdac43f14cbdfd5d117d9400d5adc860.zip | |
Merge branch 'ja/doc-lint-sections-and-synopsis' into next
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-clone.adoc')
| -rw-r--r-- | Documentation/git-clone.adoc | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/git-clone.adoc b/Documentation/git-clone.adoc index d829206d1b..57cdfb7620 100644 --- a/Documentation/git-clone.adoc +++ b/Documentation/git-clone.adoc @@ -272,7 +272,8 @@ corresponding `--mirror` and `--no-tags` options instead. reachable from a specified remote branch or tag. This option can be specified multiple times. -`--[no-]single-branch`:: +`--single-branch`:: +`--no-single-branch`:: Clone only the history leading to the tip of a single branch, either specified by the `--branch` option or the primary branch remote's `HEAD` points at. @@ -282,7 +283,8 @@ corresponding `--mirror` and `--no-tags` options instead. branch when `--single-branch` clone was made, no remote-tracking branch is created. -`--[no-]tags`:: +`--tags`:: +`--no-tags`:: Control whether or not tags will be cloned. When `--no-tags` is given, the option will be become permanent by setting the `remote.<remote>.tagOpt=--no-tags` configuration. This ensures that @@ -313,10 +315,12 @@ the clone is finished. This option is ignored if the cloned repository does not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`, or `--mirror` is given) -`--[no-]shallow-submodules`:: +`--shallow-submodules`:: +`--no-shallow-submodules`:: All submodules which are cloned will be shallow with a depth of 1. -`--[no-]remote-submodules`:: +`--remote-submodules`:: +`--no-remote-submodules`:: All submodules which are cloned will use the status of the submodule's remote-tracking branch to update the submodule, rather than the superproject's recorded SHA-1. Equivalent to passing `--remote` to |