Re: [PATCH v7 0/5] git help: group common commands by theme

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 15, 2015, 20:41 UTC
Message-ID: <CAPig+cTAMrQEfK81WWn3honj5yL5RjYvt13P63kZoZ+pQ1f98g@mail.gmail.com>
In-Reply-To: <1431714904-16599-1-git-send-email-sebastien.guimmara@gmail.com>

On Fri, May 15, 2015 at 2:34 PM, Sébastien Guimmara <sebastien.guimmara@gmail.com> wrote:

> This v7 is very similar in content to the v5 [1], except minor formatting
> adjustments in 'git help' output and recommendations from Eric.
>
> rebased on 'next' (a2776d4)

Something to keep in mind for the future: It's usually easier to manage preparatory cleanup patches by incorporating them into the series which needs/wants them rather than posting them as separate topics. That way, your patch series isn't held hostage by those separate topics. For instance, if your "whitespace fix" cleanup patch, bf990a2 (command-list.txt: fix whitespace inconsistency, 2015-05-08), which is already in 'next', had been an early patch in the current series (say patch 1/6), then you wouldn't have had to base this series on 'next'.

> The major change is in the patch series itself. Commits have been
> reordered and adjusted so that each 'apply' doesn't break the build, and
> preserve bisectability.

Thanks, the patch organization of this version (v7) looks much better than that of v5.

Show 14 quoted lines

> Summary: make 'git help' outputs a more usable and friendlier
> list of commands, grouped by theme according to the typical Git workflow:
>
> The typical Git workflow includes:
>
> start a working area (see also: git help tutorial):
>    clone      Clone a repository into a new directory
>    init       Create an empty Git repository or reinitialize an existing one
>
> work on the current change (see also: git help everyday):
>    add        Add file contents to the index
>    mv         Move or rename a file, a directory, or a symlink
>    reset      Reset current HEAD to the specified state
>    rm         Remove files from the working tree and from the index

Nice. This looks better with the extra indentation dropped[1], and it once again fits my 80-column terminal window.

One minor bike-shedding observation: The colon ":" at the end of the group headings seems unnecessary and a bit redundant with the colon at the end of "The typical Git workflow includes:". I think the group headings would read just as well (or a bit better) without the trailing colon, but I don't care strongly.

[1]: http://article.gmane.org/gmane.comp.version-control.git/268759