* Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt
@ 2022-03-09 7:55 Shaoxuan Yuan
2022-03-09 12:42 ` Bagas Sanjaya
0 siblings, 1 reply; 3+ messages in thread
From: Shaoxuan Yuan @ 2022-03-09 7:55 UTC (permalink / raw)
To: Derrick Stolee, vdye; +Cc: Git List
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt
2022-03-09 7:55 Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt Shaoxuan Yuan
@ 2022-03-09 12:42 ` Bagas Sanjaya
2022-03-09 15:23 ` Derrick Stolee
0 siblings, 1 reply; 3+ messages in thread
From: Bagas Sanjaya @ 2022-03-09 12:42 UTC (permalink / raw)
To: Shaoxuan Yuan, Derrick Stolee, vdye; +Cc: Git List
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).
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt
2022-03-09 12:42 ` Bagas Sanjaya
@ 2022-03-09 15:23 ` Derrick Stolee
0 siblings, 0 replies; 3+ messages in thread
From: Derrick Stolee @ 2022-03-09 15:23 UTC (permalink / raw)
To: Bagas Sanjaya, Shaoxuan Yuan, Derrick Stolee, vdye; +Cc: Git List
On 3/9/2022 7:42 AM, Bagas Sanjaya wrote:
> 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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-03-09 15:23 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-03-09 7:55 Add an OPTIONS chunk to Documentation/git-sparse-checkout.txt Shaoxuan Yuan
2022-03-09 12:42 ` Bagas Sanjaya
2022-03-09 15:23 ` Derrick Stolee
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).