[1/2] doc: sparse-checkout: mention --cone option
diff mbox series

Message ID 6ec39af930871496dd7694ea27eeca69d5d60c96.1579805218.git.matheus.bernardino@usp.br
State New
Headers show
Series
  • sparse-checkout: add completion and --cone to docs
Related show

Commit Message

Matheus Tavares Bernardino Jan. 23, 2020, 7 p.m. UTC
In af09ce2 ("sparse-checkout: init and set in cone mode", 2019-11-21),
the '--cone' option was added to 'git sparse-checkout init'. Add this
option to the respective doc file.

Signed-off-by: Matheus Tavares <matheus.bernardino@usp.br>
---
 Documentation/git-sparse-checkout.txt | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Martin Ågren Jan. 23, 2020, 8:28 p.m. UTC | #1
Hi Matheus,

On Thu, 23 Jan 2020 at 20:02, Matheus Tavares <matheus.bernardino@usp.br> wrote:
> In af09ce2 ("sparse-checkout: init and set in cone mode", 2019-11-21),
> the '--cone' option was added to 'git sparse-checkout init'. Add this
> option to the respective doc file.

Nit: s/respective/corresponding/

"Respective" sounds -- to me at least -- like you're tweaking two
different files. Maybe that's just me.

>  To avoid interfering with other worktrees, it first enables the
>  `extensions.worktreeConfig` setting and makes sure to set the
>  `core.sparseCheckout` setting in the worktree-specific config file.
> ++
> +When `--cone` is provided the `core.sparseCheckoutCone` setting is also

Nit: maybe add a comma after "provided". Without it, I could see someone
false-starting the parsing as "provided with the" or even "provided to
the". Those readings obviously don't work out in the end, but with an
extra comma, I think it's easier to just naturally read this the way
it's intended.

> +set, allowing for better performance with a limited set of patterns
> +(see 'CONE PATTERN SET' bellow).

s/bellow/below/

Martin
Matheus Tavares Bernardino Jan. 24, 2020, 1:51 a.m. UTC | #2
Hi, Martin

On Thu, Jan 23, 2020 at 5:28 PM Martin Ågren <martin.agren@gmail.com> wrote:
>
> Hi Matheus,
>
> On Thu, 23 Jan 2020 at 20:02, Matheus Tavares <matheus.bernardino@usp.br> wrote:
> > In af09ce2 ("sparse-checkout: init and set in cone mode", 2019-11-21),
> > the '--cone' option was added to 'git sparse-checkout init'. Add this
> > option to the respective doc file.
>
> Nit: s/respective/corresponding/
>
> "Respective" sounds -- to me at least -- like you're tweaking two
> different files. Maybe that's just me.
>
> >  To avoid interfering with other worktrees, it first enables the
> >  `extensions.worktreeConfig` setting and makes sure to set the
> >  `core.sparseCheckout` setting in the worktree-specific config file.
> > ++
> > +When `--cone` is provided the `core.sparseCheckoutCone` setting is also
>
> Nit: maybe add a comma after "provided". Without it, I could see someone
> false-starting the parsing as "provided with the" or even "provided to
> the". Those readings obviously don't work out in the end, but with an
> extra comma, I think it's easier to just naturally read this the way
> it's intended.
>
> > +set, allowing for better performance with a limited set of patterns
> > +(see 'CONE PATTERN SET' bellow).
>
> s/bellow/below/

Thanks for the comments. Junio has already addressed them[1] when
picking up the patch :)

[1]: https://github.com/gitster/git/commit/a402723e488c66bd12cf674c332f185fee1d2347

Patch
diff mbox series

diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index 974ade2238..542af98520 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -41,6 +41,10 @@  COMMANDS
 To avoid interfering with other worktrees, it first enables the
 `extensions.worktreeConfig` setting and makes sure to set the
 `core.sparseCheckout` setting in the worktree-specific config file.
++
+When `--cone` is provided the `core.sparseCheckoutCone` setting is also
+set, allowing for better performance with a limited set of patterns
+(see 'CONE PATTERN SET' bellow).
 
 'set'::
 	Write a set of patterns to the sparse-checkout file, as given as