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

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 15, 2015, 21:31 UTC
Message-ID: <CAPig+cSJJroxRF2He4ZvmgijZVw9ULOnUCEWyxGry=--L851YA@mail.gmail.com>
In-Reply-To: <1431714904-16599-3-git-send-email-sebastien.guimmara@gmail.com>

On Fri, May 15, 2015 at 2:35 PM, Sébastien Guimmara <sebastien.guimmara@gmail.com> 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.

Show 11 quoted lines

>     [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@sunshineco.com>
> Helped-by: Junio C Hamano <gitster@pobox.com>
> Helped-by:  Emma Jane Hogbin Westby <emma.westby@gmail.com>
> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>