diff mbox series

config/core.txt: fix minor issues for `core.sparseCheckoutCone`

Message ID 20220718100530.2068354-1-martin.agren@gmail.com (mailing list archive)
State Accepted
Commit ae436f283c05824874a0c8a534eee8950de4f740
Headers show
Series config/core.txt: fix minor issues for `core.sparseCheckoutCone` | expand

Commit Message

Martin Ågren July 18, 2022, 10:05 a.m. UTC
The sparse checkout feature can be used in "cone mode" or "non-cone
mode". In this one instance in the documentation, we refer to the latter
as "non cone mode" with whitespace rather than a hyphen. Align this with
the rest of our documentation.

A few words later in the same paragraph, there's mention of "a more
flexible patterns". Drop that leading "a" to fix the grammar.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 BTW, Elijah, it seems like you've recently started using different
 e-mail addresses, even within the same series [1]. Not sure if that's
 intentional or not? I decided to cc the one you've used by far the most
 rather than spamming all of your accounts.

 [1] https://lore.kernel.org/git/pull.1268.v4.git.1656984823.gitgitgadget@gmail.com/

 Documentation/config/core.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Derrick Stolee July 18, 2022, 12:20 p.m. UTC | #1
On 7/18/22 6:05 AM, Martin Ågren wrote:
> The sparse checkout feature can be used in "cone mode" or "non-cone
> mode". In this one instance in the documentation, we refer to the latter
> as "non cone mode" with whitespace rather than a hyphen. Align this with
> the rest of our documentation.
> 
> A few words later in the same paragraph, there's mention of "a more
> flexible patterns". Drop that leading "a" to fix the grammar.

Thank you for your attention to detail. This is a good change.

Thanks,
-Stolee
Elijah Newren July 18, 2022, 3:28 p.m. UTC | #2
On Mon, Jul 18, 2022 at 3:05 AM Martin Ågren <martin.agren@gmail.com> wrote:
>
> The sparse checkout feature can be used in "cone mode" or "non-cone
> mode". In this one instance in the documentation, we refer to the latter
> as "non cone mode" with whitespace rather than a hyphen. Align this with
> the rest of our documentation.
>
> A few words later in the same paragraph, there's mention of "a more
> flexible patterns". Drop that leading "a" to fix the grammar.

Ooh, sounds like a good catch.

> Signed-off-by: Martin Ågren <martin.agren@gmail.com>
> ---
>  BTW, Elijah, it seems like you've recently started using different
>  e-mail addresses, even within the same series [1]. Not sure if that's
>  intentional or not? I decided to cc the one you've used by far the most
>  rather than spamming all of your accounts.

Not intentional.  Looks like it has already merged to next, though, or
I'd reroll and correct.  Maybe I should submit an entry for .mailmap.

(Hard drive in my work computer died somewhat recently.  There, I use
my work email for most things; almost everything other than git.git.
When recloning git.git on my replacement computer, I forgot to set
user.email in my git.git clone to override the value found in the
global ~/.gitconfig.)

>  [1] https://lore.kernel.org/git/pull.1268.v4.git.1656984823.gitgitgadget@gmail.com/
>
>  Documentation/config/core.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/core.txt b/Documentation/config/core.txt
> index 3ea3124f7f..37afbaf5a4 100644
> --- a/Documentation/config/core.txt
> +++ b/Documentation/config/core.txt
> @@ -722,8 +722,8 @@ core.sparseCheckout::
>  core.sparseCheckoutCone::
>         Enables the "cone mode" of the sparse checkout feature. When the
>         sparse-checkout file contains a limited set of patterns, this
> -       mode provides significant performance advantages. The "non
> -       cone mode" can be requested to allow specifying a more flexible
> +       mode provides significant performance advantages. The "non-cone
> +       mode" can be requested to allow specifying more flexible
>         patterns by setting this variable to 'false'. See
>         linkgit:git-sparse-checkout[1] for more information.
>
> --
> 2.37.1.373.g4dd4a117ec

This looks good, thanks.

Reviewed-by: Elijah Newren <newren@gmail.com>
diff mbox series

Patch

diff --git a/Documentation/config/core.txt b/Documentation/config/core.txt
index 3ea3124f7f..37afbaf5a4 100644
--- a/Documentation/config/core.txt
+++ b/Documentation/config/core.txt
@@ -722,8 +722,8 @@  core.sparseCheckout::
 core.sparseCheckoutCone::
 	Enables the "cone mode" of the sparse checkout feature. When the
 	sparse-checkout file contains a limited set of patterns, this
-	mode provides significant performance advantages. The "non
-	cone mode" can be requested to allow specifying a more flexible
+	mode provides significant performance advantages. The "non-cone
+	mode" can be requested to allow specifying more flexible
 	patterns by setting this variable to 'false'. See
 	linkgit:git-sparse-checkout[1] for more information.