Re: [PATCH 1/3] command-list.txt: group common commands by theme

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, May 4, 2015 at 4:28 PM, Sébastien Guimmara
<sebastien.guimmara@xxxxxxxxx> wrote:
> Declare groups for common commands in the [groups] block,
> followed by group names and descriptions:
>
>    [groups]
>    init                   starting a working area
>    worktree               working on the current change
>    remote                 working with others
>    info                   examining the history and state
>    history                growing, marking and tweaking your history
>
> Then, in the [commands] block, map all common commands with a group:
>
>    [commands]
>    git-add        mainporcelain     common-worktree
>    git-branch     mainporcelain     common-history
>    git-checkout   mainporcelain     common-history
>    [...]
>
> command names and groups are then parsed with generate-cmdlist.sh to
> generate common-commands.h.
>
> Those commands are displayed in groups in the output of 'git help'.

It probably also is important to mention that the order of the items
in [groups] is the order in which groups are output by 'git help'

More below.

> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@xxxxxxxxx>
> ---
> diff --git a/command-list.txt b/command-list.txt
> index f1eae08..64394ca 100644
> --- a/command-list.txt
> +++ b/command-list.txt
> @@ -1,29 +1,39 @@
>  # List of known git commands.
> -# command name                         category [deprecated] [common]
> -git-add                                 mainporcelain common
> +# only add group information for common commands

Perhaps mention also that the order of groups here is the order in
which they are output by 'git help'?

> +[groups]

Thinking on this a bit more, perhaps [groups] is too generic. Maybe
[common] or [commongroups] would be more descriptive?

> +init                   starting a working area
> +worktree               working on the current change
> +remote                 working with others

"collaborating with others" perhaps?

More below.

> +info                   examining the history and state
> +history                growing, marking and tweaking your history
> +
> +# command name         [deprecated]     category                     [group]
> +[commands]
> +git-add                                 mainporcelain                common-worktree
>  [...]
> -git-bisect                              mainporcelain common
> +git-bisect                              mainporcelain
>  [...]
> -git-branch                              mainporcelain common
> +git-branch                              mainporcelain                common-history
>  [...]
> -git-checkout                            mainporcelain common
> +git-checkout                            mainporcelain                common-history
>  [...]
> -git-clone                               mainporcelain common
> +git-clone                               mainporcelain                common-init
>  [...]
> -git-commit                              mainporcelain common
> +git-commit                              mainporcelain                common-history
>  [...]
> -git-diff                                mainporcelain common
> +git-diff                                mainporcelain                common-history
>  [...]
> -git-fast-export                                ancillarymanipulators
> -git-fast-import                                ancillarymanipulators
> -git-fetch                               mainporcelain common
> +git-fast-export                         ancillarymanipulators
> +git-fast-import                         ancillarymanipulators

Unintended whitespace changes for fast-export and fast-import lines? I
wouldn't have expected to see these lines change in this patch.

> +git-fetch                               mainporcelain                common-remote
>  [...]
> -git-fsck                               ancillaryinterrogators
> +git-fsck                                ancillaryinterrogators

Unintended whitespace change?

>  [...]
> -git-grep                                mainporcelain common
> +git-grep                                mainporcelain

This change isn't mentioned anywhere, not even in the cover letter.
Did you intend to drop 'grep' from the common command list?

>  [...]
> -git-help                               ancillaryinterrogators
> +git-help                                ancillaryinterrogators

Whitespace change?

More below.

>  [...]
> -git-init                                mainporcelain common
> +git-init                                mainporcelain                common-init
>  [...]
> -git-log                                 mainporcelain common
> +git-log                                 mainporcelain                common-info
>  [...]
> -git-merge                               mainporcelain common
> +git-merge                               mainporcelain                common-history
>  [...]
> -git-mv                                  mainporcelain common
> +git-mv                                  mainporcelain
>  [...]
> -git-pull                                mainporcelain common
> -git-push                                mainporcelain common
> +git-pull                                mainporcelain                common-remote
> +git-push                                mainporcelain                common-remote
>  [...]
> -git-rebase                              mainporcelain common
> +git-rebase                              mainporcelain
>  [...]
> -git-reset                               mainporcelain common
> +git-reset                               mainporcelain                common-worktree
>  [...]
> -git-rm                                  mainporcelain common
> +git-rm                                  mainporcelain
>  [...]
> -git-show                                mainporcelain common
> +git-show                                mainporcelain
>  [...]
> -git-status                              mainporcelain common
> +git-status                              mainporcelain                common-info
>  [...]
> -git-tag                                 mainporcelain common
> +git-tag                                 mainporcelain

This change also is not mentioned anywhere.

>  [...]
> -git-write-tree                          plumbingmanipulators
> +git-write-tree                          plumbingmanipulators
> \ No newline at end of file

Your editor is perhaps dropping the final newline in the file? This is
an undesirable change. Patch 2/3 exhibits the same problem.

> --
> 2.4.0
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]