public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Ramsay Jones <ramsay@ramsay1•demon.co.uk>
To: "Sébastien Guimmara" <sebastien.guimmara@gmail•com>, git@vger•kernel.org
Cc: sunshine@sunshineco•com, gitster@pobox•com
Subject: Re: [PATCH v9 5/5] help: respect new common command grouping
Date: Wed, 20 May 2015 22:39:00 +0100	[thread overview]
Message-ID: <555CFEF4.5000002@ramsay1.demon.co.uk> (raw)
In-Reply-To: <1432149781-24596-6-git-send-email-sebastien.guimmara@gmail.com>

On 20/05/15 20:23, Sébastien Guimmara wrote:
> 'git help' shows common commands in alphabetical order:
> 
> The most commonly used git commands are:
>    add        Add file contents to the index
>    bisect     Find by binary search the change that introduced a bug
>    branch     List, create, or delete branches
>    checkout   Checkout a branch or paths to the working tree
>    clone      Clone a repository into a new directory
>    commit     Record changes to the repository
>    [...]
> 
> without any indication of how commands relate to high-level
> concepts or each other. Revise the output to explain their relationship
> with the typical Git workflow:
> 
> These are common Git commands used in various situations:
> 
> 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 [...]
> 
> work on the current change (see also: git help everyday)
>    add        Add file contents to the index
>    reset      Reset current HEAD to the specified state
> 
> examine the history and state (see also: git help revisions)
>    log        Show commit logs
>    status     Show the working tree status
> 
>    [...]
> 
> Helped-by: Eric Sunshine <sunshine@sunshineco•com>
> Signed-off-by: Ramsay Jones <ramsay@ramsay1•demon.co.uk>

This should be (at most) 'Helped-by:' - my 'contribution' was
so minor that even a 'Helped-by:' is generous! :-D

ATB,
Ramsay Jones

> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail•com>
> ---
>  help.c | 24 +++++++++++++++++++++++-
>  1 file changed, 23 insertions(+), 1 deletion(-)
> 
> diff --git a/help.c b/help.c
> index 2072a87..8f72051 100644
> --- a/help.c
> +++ b/help.c
> @@ -218,17 +218,39 @@ void list_commands(unsigned int colopts,
>  	}
>  }
>  
> +static int cmd_group_cmp(const void *elem1, const void *elem2)
> +{
> +	const struct cmdname_help *e1 = elem1;
> +	const struct cmdname_help *e2 = elem2;
> +
> +	if (e1->group < e2->group)
> +		return -1;
> +	if (e1->group > e2->group)
> +		return 1;
> +	return strcmp(e1->name, e2->name);
> +}
> +
>  void list_common_cmds_help(void)
>  {
>  	int i, longest = 0;
> +	int current_grp = -1;
>  
>  	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
>  		if (longest < strlen(common_cmds[i].name))
>  			longest = strlen(common_cmds[i].name);
>  	}
>  
> -	puts(_("The most commonly used git commands are:"));
> +	qsort(common_cmds, ARRAY_SIZE(common_cmds),
> +		sizeof(common_cmds[0]), cmd_group_cmp);
> +
> +	puts(_("These are common Git commands used in various situations:"));
> +
>  	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
> +		if (common_cmds[i].group != current_grp) {
> +			printf("\n%s\n", _(common_cmd_groups[common_cmds[i].group]));
> +			current_grp = common_cmds[i].group;
> +		}
> +
>  		printf("   %s   ", common_cmds[i].name);
>  		mput_char(' ', longest - strlen(common_cmds[i].name));
>  		puts(_(common_cmds[i].help));
> 

  reply	other threads:[~2015-05-20 21:39 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-20 19:22 [PATCH v9 0/5] group common commands by theme Sébastien Guimmara
2015-05-20 19:22 ` [PATCH v9 1/5] command-list: prepare machinery for upcoming "common groups" section Sébastien Guimmara
2015-05-20 19:22 ` [PATCH v9 2/5] command-list.txt: add the common groups block Sébastien Guimmara
2015-05-20 19:48   ` Eric Sunshine
2015-05-20 19:51     ` Sébastien Guimmara
2015-05-20 19:22 ` [PATCH v9 3/5] generate-cmdlist: parse common group commands Sébastien Guimmara
2015-05-20 19:27   ` Sébastien Guimmara
2015-05-20 19:32     ` Stefan Beller
2015-05-20 19:34       ` Sébastien Guimmara
2015-05-20 19:32     ` Eric Sunshine
2015-05-20 19:23 ` [PATCH v9 4/5] command-list.txt: drop the "common" tag Sébastien Guimmara
2015-05-20 19:23 ` [PATCH v9 5/5] help: respect new common command grouping Sébastien Guimmara
2015-05-20 21:39   ` Ramsay Jones [this message]
2015-05-20 21:42     ` Sébastien Guimmara
2015-05-20 19:31 ` [PATCH v9 0/5] group common commands by theme Eric Sunshine

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=555CFEF4.5000002@ramsay1.demon.co.uk \
    --to=ramsay@ramsay1$(echo .)demon.co.uk \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=sebastien.guimmara@gmail$(echo .)com \
    --cc=sunshine@sunshineco$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox