threads / discuss / 57523

Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt

Subject: Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt

## tl;dr

3 messages between Mar 9, 2022 and Mar 9, 2022.

replies: 2people: 3as markdown or json

Shaoxuan Yuan· Mar 9, 2022, 07:55 UTC · lore
Hi all,

I'm wondering if we could add an OPTIONS chunk to Documentation/git-sparse-checkout.txt?

Cause when I was skimming through the SYNOPSIS and it says "git sparse-checkout <subcommand> [<options>]" but I didn't quite see the options until I read into the COMMANDS.

Perhaps something like this:
OPTIONS
    --[no-]cone
    --[no-]sparse-index
    --stdin
If this is okay to do then I will try to submit a patch later :)
-- 
Thanks & Regards,
Shaoxuan
Bagas Sanjaya· Mar 9, 2022, 12:42 UTC · re: Shaoxuan Yuan · lore

Re: Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt

On 09/03/22 14.55, Shaoxuan Yuan wrote:
Show 20 quoted lines
> Hi all,
> 
> I'm wondering if we could add an OPTIONS chunk to
> Documentation/git-sparse-checkout.txt?
> 
> Cause when I was skimming through the SYNOPSIS
> and it says "git sparse-checkout <subcommand> [<options>]"
> but I didn't quite see the options until I read into the COMMANDS.
> 
> Perhaps something like this:
> 
> OPTIONS
> 
>      --[no-]cone
> 
>      --[no-]sparse-index
> 
>      --stdin
> 
> If this is okay to do then I will try to submit a patch later :)

OK, but we need to list out subcommands and options in the SYNOPSIS, much like in git-worktree(1) and git-submodule(1).

-- 
An old man doll... just what I always wanted! - Clara
Derrick Stolee· Mar 9, 2022, 15:23 UTC · re: Bagas Sanjaya · lore

Re: Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt

On 3/9/2022 7:42 AM, Bagas Sanjaya wrote:
Show 24 quoted lines
> On 09/03/22 14.55, Shaoxuan Yuan wrote:
>> Hi all,
>>
>> I'm wondering if we could add an OPTIONS chunk to
>> Documentation/git-sparse-checkout.txt?
>>
>> Cause when I was skimming through the SYNOPSIS
>> and it says "git sparse-checkout <subcommand> [<options>]"
>> but I didn't quite see the options until I read into the COMMANDS.
>>
>> Perhaps something like this:
>>
>> OPTIONS
>>
>>      --[no-]cone
>>
>>      --[no-]sparse-index
>>
>>      --stdin
>>
>> If this is okay to do then I will try to submit a patch later :)
> 
> OK, but we need to list out subcommands and options in the SYNOPSIS,
> much like in git-worktree(1) and git-submodule(1).

Thank you for showing an interest in improving our docs! Be sure to start from Elijah's recent series [1] that overhauls the docs in a few different ways, just to avoid conflicts.

[1] https://lore.kernel.org/git/pull.1148.git.1646725188.gitgitgadget@gmail.com/

Thanks, -Stolee

← back to recent threads