Re: [PATCH v7 2/5] command-list.txt: add a [common] block

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

 



On Fri, May 15, 2015 at 2:35 PM, Sébastien Guimmara
<sebastien.guimmara@xxxxxxxxx> wrote:
> Add a [common] block at the beginning of command-list.txt:

Without benefit of the explanation in the cover letter, the reason for
this change is a bit mysterious. Even a single sentence preceding this
one could help clarify. Perhaps the above could be rewritten something
like this:

    The ultimate goal is for "git help" to display common commands in
    groups rather than alphabetically. As a first step, define the
    groups in a new [common] block, and then assign a group to each
    common command.

>     [common]
>     init         start a working area (see also: git help tutorial)
>     worktree     work on the current change (see also:[...]
>     info         examine the history and state (see also: git [...]
>     history      grow, mark and tweak your history
>     remote       collaborate (see also: git help workflows)
>
> storing information about common commands group, then map each common
> command to a group:
>
>     git-add          mainporcelain        common worktree

With the above rewritten explanation, the rest of the commit message
(the above examples) becomes pretty much unnecessary and merely
repeats what the patch itself already says.

> Helped-by: Eric Sunshine <sunshine@xxxxxxxxxxxxxx>
> Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
> Helped-by:  Emma Jane Hogbin Westby <emma.westby@xxxxxxxxx>
> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@xxxxxxxxx>
--
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]