threads / patch / 56771

patchcommand-list.txt: remove 'sparse-index' from main help

Subject: [PATCH] command-list.txt: remove 'sparse-index' from main help

## tl;dr

4 messages between Oct 24, 2021 and Oct 25, 2021. Diffs are folded; open one to read it.

replies: 3people: 4as markdown or json

SZEDER Gábor· Oct 24, 2021, 17:07 UTC · lore

Ever since 'git sparse-checkout' was introduced [1] it is included in 'git --help' in the section "work on the current change" along with the commands 'add', 'mv', 'restore', and 'rm'. It clearly doesn't belong to that group, moreover it can't be considered such a common command to belong to 'git --help' in the first place, so remove it from there.

[1] 94c0956b60 (sparse-checkout: create builtin with 'list'
                subcommand, 2019-11-21)

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 command-list.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to command-list.txt +1 −1

diff --git a/command-list.txt b/command-list.txt
index a289f09ed6..eb9cee8dee 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -168,7 +168,7 @@ git-show-index                          plumbinginterrogators
 git-show-ref                            plumbinginterrogators
 git-sh-i18n                             purehelpers
 git-sh-setup                            purehelpers
-git-sparse-checkout                     mainporcelain           worktree
+git-sparse-checkout                     mainporcelain
 git-stash                               mainporcelain
 git-stage                                                               complete
 git-status                              mainporcelain           info

-- 
2.33.1.1176.g03b4fe3d2b

Martin Ågren· Oct 24, 2021, 17:27 UTC · re: SZEDER Gábor · lore

Re: [PATCH] command-list.txt: remove 'sparse-index' from main help

On Sun, 24 Oct 2021 at 19:08, SZEDER Gábor <szeder.dev@gmail.com> wrote:

Show 7 quoted lines

>
> Ever since 'git sparse-checkout' was introduced [1] it is included in
> 'git --help' in the section "work on the current change" along with
> the commands 'add', 'mv', 'restore', and 'rm'.  It clearly doesn't
> belong to that group, moreover it can't be considered such a common
> command to belong to 'git --help' in the first place, so remove it
> from there.

I actually spotted this in `git --help` just the other day and reacted along the same line. So for what it's worth, this patch makes sense to me.

Incidentally, this drops quite some indentation in `git --help` (because "sparse-checkout" is by far the longest subcommand listed there). After this patch, we're back within 80 columns again.

Martin

Derrick Stolee· Oct 25, 2021, 15:33 UTC · re: SZEDER Gábor · lore

Re: [PATCH] command-list.txt: remove 'sparse-index' from main help

On 10/24/2021 1:07 PM, SZEDER Gábor wrote:

Show 11 quoted lines

> Ever since 'git sparse-checkout' was introduced [1] it is included in
> 'git --help' in the section "work on the current change" along with
> the commands 'add', 'mv', 'restore', and 'rm'.  It clearly doesn't
> belong to that group, moreover it can't be considered such a common
> command to belong to 'git --help' in the first place, so remove it
> from there.
> 
> [1] 94c0956b60 (sparse-checkout: create builtin with 'list'
>                 subcommand, 2019-11-21)
> -git-sparse-checkout                     mainporcelain           worktree
> +git-sparse-checkout                     mainporcelain

Thanks! I didn't realize what a pain it would be to include the 'worktree' grouping here.

-Stolee

Junio C Hamano· Oct 25, 2021, 16:10 UTC · re: SZEDER Gábor · lore

Re: [PATCH] command-list.txt: remove 'sparse-index' from main help

SZEDER Gábor <szeder.dev@gmail.com> writes:

Show 14 quoted lines

> Ever since 'git sparse-checkout' was introduced [1] it is included in
> 'git --help' in the section "work on the current change" along with
> the commands 'add', 'mv', 'restore', and 'rm'.  It clearly doesn't
> belong to that group, moreover it can't be considered such a common
> command to belong to 'git --help' in the first place, so remove it
> from there.
>
> [1] 94c0956b60 (sparse-checkout: create builtin with 'list'
>                 subcommand, 2019-11-21)
>
> Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
> ---
>  command-list.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Redirecting to Stolee just in case for an Ack.

I tend to agree that this is a housekeeping command for a local repository to control what are and what are not materialized in the working tree. It does not directly affect the history produced from there, similar to "git gc" is, so in that sense, I do not think we would miss it in the "list of usual commands".

If I had to have it in some category, I do agree with the current code that it belongs to the "worktree" family, though.

Thanks, will queue.

Show 13 quoted lines

> diff --git a/command-list.txt b/command-list.txt
> index a289f09ed6..eb9cee8dee 100644
> --- a/command-list.txt
> +++ b/command-list.txt
> @@ -168,7 +168,7 @@ git-show-index                          plumbinginterrogators
>  git-show-ref                            plumbinginterrogators
>  git-sh-i18n                             purehelpers
>  git-sh-setup                            purehelpers
> -git-sparse-checkout                     mainporcelain           worktree
> +git-sparse-checkout                     mainporcelain
>  git-stash                               mainporcelain
>  git-stage                                                               complete
>  git-status                              mainporcelain           info