From: Jeff King <peff@peff.net>
To: Rasmus Villemoes <rv@rasmusvillemoes.dk>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
Duy Nguyen <pclouds@gmail.com>, Taylor Blau <me@ttaylorr.com>
Subject: Re: [PATCH v2 2/3] git.c: handle_alias: prepend alias info when first argument is -h
Date: Tue, 2 Oct 2018 22:16:07 -0400 [thread overview]
Message-ID: <20181003021607.GB20553@sigill.intra.peff.net> (raw)
In-Reply-To: <20181001112107.28956-2-rv@rasmusvillemoes.dk>
On Mon, Oct 01, 2018 at 01:21:06PM +0200, Rasmus Villemoes wrote:
> Most git commands respond to -h anywhere in the command line, or at
> least as a first and lone argument, by printing the usage
> information. For aliases, we can provide a little more information that
> might be useful in interpreting/understanding the following output by
> prepending a line telling that the command is an alias, and for what.
>
> When one invokes a simple alias, such as "cp = cherry-pick"
> with -h, this results in
>
> $ git cp -h
> 'cp' is aliased to 'cherry-pick'
> usage: git cherry-pick [<options>] <commit-ish>...
> ...
>
> When the alias consists of more than one word, this provides the
> additional benefit of informing the user which options are implicit in
> using the alias, e.g. with "cp = cherry-pick -n":
>
> $ git cp -h
> 'cp' is aliased to 'cherry-pick -n'
> usage: git cherry-pick [<options>] <commit-ish>...
> ...
>
> For shell commands, we cannot know how it responds to -h, but printing
> this line to stderr should not hurt, and can help in figuring out what
> is happening in a case like
>
> $ git sc -h
> 'sc' is aliased to '!somecommand'
> somecommand: invalid option '-h'
Nicely explained.
> diff --git a/git.c b/git.c
> index a6f4b44af5..0211c2d4c0 100644
> --- a/git.c
> +++ b/git.c
> @@ -318,6 +318,9 @@ static int handle_alias(int *argcp, const char ***argv)
> alias_command = (*argv)[0];
> alias_string = alias_lookup(alias_command);
> if (alias_string) {
> + if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
> + fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
> + alias_command, alias_string);
> if (alias_string[0] == '!') {
> struct child_process child = CHILD_PROCESS_INIT;
> int nongit_ok;
And the implementation makes sense.
-Peff
next prev parent reply other threads:[~2018-10-03 2:18 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-26 10:26 [PATCH] help: allow redirecting to help for aliased command Rasmus Villemoes
2018-09-26 14:37 ` Taylor Blau
2018-09-26 15:19 ` Duy Nguyen
2018-09-28 7:44 ` Rasmus Villemoes
2018-09-26 15:30 ` Junio C Hamano
2018-09-26 18:09 ` Taylor Blau
2018-09-26 18:20 ` Junio C Hamano
2018-09-26 15:16 ` Duy Nguyen
2018-09-26 15:16 ` Junio C Hamano
2018-09-26 18:12 ` Taylor Blau
2018-09-28 7:53 ` Rasmus Villemoes
2018-09-26 18:49 ` Jeff King
2018-09-26 19:31 ` Junio C Hamano
2018-09-28 8:18 ` Rasmus Villemoes
2018-09-29 8:21 ` Jeff King
2018-09-29 17:39 ` Junio C Hamano
2018-09-30 4:27 ` Jeff King
2018-09-30 5:27 ` Junio C Hamano
2018-09-30 5:53 ` Jeff King
2018-09-28 7:40 ` Rasmus Villemoes
2018-09-28 17:00 ` Junio C Hamano
2018-10-01 11:21 ` [PATCH v2 1/3] help: redirect to aliased commands for "git cmd --help" Rasmus Villemoes
2018-10-01 11:21 ` [PATCH v2 2/3] git.c: handle_alias: prepend alias info when first argument is -h Rasmus Villemoes
2018-10-03 2:16 ` Jeff King [this message]
2018-10-01 11:21 ` [PATCH v2 3/3] git-help.txt: document "git help cmd" vs "git cmd --help" for aliases Rasmus Villemoes
2018-10-03 2:18 ` Jeff King
2018-10-03 6:25 ` Rasmus Villemoes
2018-10-03 2:13 ` [PATCH v2 1/3] help: redirect to aliased commands for "git cmd --help" Jeff King
2018-10-03 6:24 ` Rasmus Villemoes
2018-10-03 7:06 ` Jeff King
2018-10-03 11:42 ` [PATCH v3 0/3] alias help tweaks Rasmus Villemoes
2018-10-03 11:42 ` [PATCH v3 1/3] help: redirect to aliased commands for "git cmd --help" Rasmus Villemoes
2018-10-05 8:19 ` Junio C Hamano
2018-10-05 10:22 ` Rasmus Villemoes
2018-10-05 16:47 ` Junio C Hamano
2018-10-03 11:42 ` [PATCH v3 2/3] git.c: handle_alias: prepend alias info when first argument is -h Rasmus Villemoes
2018-10-03 11:42 ` [PATCH v3 3/3] git-help.txt: document "git help cmd" vs "git cmd --help" for aliases Rasmus Villemoes
2018-10-04 0:10 ` [PATCH v3 0/3] alias help tweaks Jeff King
2018-10-09 11:59 ` [PATCH v4 " Rasmus Villemoes
2018-10-09 11:59 ` [PATCH v4 1/3] help: redirect to aliased commands for "git cmd --help" Rasmus Villemoes
2018-10-09 11:59 ` [PATCH v4 2/3] git.c: handle_alias: prepend alias info when first argument is -h Rasmus Villemoes
2018-10-09 11:59 ` [PATCH v4 3/3] git-help.txt: document "git help cmd" vs "git cmd --help" for aliases Rasmus Villemoes
2018-10-12 3:17 ` [PATCH v4 0/3] alias help tweaks Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181003021607.GB20553@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
--cc=pclouds@gmail.com \
--cc=rv@rasmusvillemoes.dk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).