]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: remove stray bracket from git-clone synopsis
authorKnut Harald Ryager <e-k-nut@hotmail.com>
Mon, 11 Aug 2025 22:04:32 +0000 (22:04 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 12 Aug 2025 15:57:57 +0000 (08:57 -0700)
The synopsis section has an extra closing bracket, like this:

    [--filter=<filter>] [--also-filter-submodules]]

The extra one is not the one at the end of this line; it is the one
after "...=<filter>".

The "--also-filter-submodules" option was added by f05da2b4 (clone,
submodule: pass partial clone filters to submodules, 2022-02-04).
Because it makes sense only when used with the "--filter=<filter>"
option, these two options are enclosed in a pair of brackets.  The
extra one was added by 76880f05 (doc: git-clone: apply new
documentation formatting guidelines, 2024-03-29) by mistake.

Remove the extra and incorrect closing bracket, so that the line
reads:

    [--filter=<filter> [--also-filter-submodules]]

Signed-off-by: Knut Harald Ryager <e-k-nut@hotmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-clone.txt

index de8d8f58930ecff305f79480b13ddce10cd96c60..c0d8e1e89779d5ad61021e20fdc3773efcd27c93 100644 (file)
@@ -16,7 +16,7 @@ git clone [--template=<template-directory>]
          [--depth <depth>] [--[no-]single-branch] [--no-tags]
          [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
          [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
-         [--filter=<filter-spec>] [--also-filter-submodules]] [--] <repository>
+         [--filter=<filter-spec> [--also-filter-submodules]] [--] <repository>
          [<directory>]
 
 DESCRIPTION