Re: [PATCH v5 5/6] new-command.txt: mention the common command groups

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 11, 2015, 06:47 UTC
Message-ID: <CAPig+cTwRawmrX2MHyUhC9Dm3CaCGANZdgOV=TKJ3Fqx2OWwXQ@mail.gmail.com>
In-Reply-To: <1431191856-10949-6-git-send-email-sebastien.guimmara@gmail.com>

On Sat, May 9, 2015 at 1:17 PM, Sébastien Guimmara <sebastien.guimmara@gmail.com> wrote:

> In the 6. step, add information about the common group commands
> found in command-list.txt.

I don't feel too strongly about it, but as this is such a minor change, and as it is directly related to the addition of the [common] second in command-list.txt, it also would make sense just to fold this change into the patch which introduces [common] (that is, v5 patch 3/6).

Show 19 quoted lines

> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
> ---
> diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
> index d7de5a3..e7b0cc2 100644
> --- a/Documentation/howto/new-command.txt
> +++ b/Documentation/howto/new-command.txt
> @@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
>  that categorizes commands by type, so they can be listed in appropriate
>  subsections in the documentation's summary command list.  Add an entry
>  for yours.  To understand the categories, look at git-commands.txt
> -in the main directory.
> +in the main directory. If the new command is part of the typical Git
> +workflow and you believe it's common enough to be mentioned in
> +'git help', map this command to a common group in the column [common]
>
>  7. Give the maintainer one paragraph to include in the RelNotes file
>  to describe the new feature; a good place to do so is in the cover
> --
> 2.4.0