Re: [PATCH v3] docs: remove stray bracket from git-clone synopsis

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 12, 2025, 15:55 UTC
Message-ID: <xmqqms84v8jy.fsf@gitster.g>
In-Reply-To: <pull.2023.v3.git.git.1754949872593.gitgitgadget@gmail.com>

"Knut Harald Ryager via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 16 quoted lines

> From: Knut Harald Ryager <e-k-nut@hotmail.com>
>
> Remove the extra and incorrect closing bracket, so that the line reads:
>
>     [--filter=<filter> [--also-filter-submodules]]
>
> instead of
>
>     [--filter=<filter>] [--also-filter-submodules]]
>
> Note: Both filter options were grouped when --also-filter-submodules
> was added by commit f05da2b4. The extra bracket was added
> later by commit 76880f05.
>
> Signed-off-by: Knut Harald Ryager <e-k-nut@hotmail.com>
> ---

Thanks.  Let me rewrite the proposed log message thusly:

--- >8 ---
Subject: docs: remove stray bracket from git-clone synopsis

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>