* Support "git cmd --help" syntax
@ 2006-04-15 18:13 Linus Torvalds
2006-04-15 20:54 ` Junio C Hamano
0 siblings, 1 reply; 5+ messages in thread
From: Linus Torvalds @ 2006-04-15 18:13 UTC (permalink / raw)
To: Junio C Hamano, Git Mailing List
The "--help" argument is special, in that it is (along with "--version")
in that is taken by the "git" program itself rather than the sub-command,
and thus we've had the syntax "git --help cmd".
However, as anybody who has ever used CVS or some similar devil-spawn
program, it's confusing as h*ll when options before the sub-command act
differently from options after the sub-command, so this quick hack just
makes it acceptable to do "git cmd --help" instead, and get the exact same
result.
It may be hacky, but it's simple and does the trick.
Of course, this does not help if you use one of the non-builtin commands
without using the "git" helper. Ie you won't be getting a man-page just
because you do "git-rev-list --help". Don't expect us to be quite _that_
helpful.
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
---
diff --git a/git.c b/git.c
index 78ed403..13c6d51 100644
--- a/git.c
+++ b/git.c
@@ -411,6 +411,12 @@ static void handle_internal_command(int
};
int i;
+ /* Turn "git cmd --help" into "git help cmd" */
+ if (argc > 1 && !strcmp(argv[1], "--help")) {
+ argv[1] = argv[0];
+ argv[0] = cmd = "help";
+ }
+
for (i = 0; i < ARRAY_SIZE(commands); i++) {
struct cmd_struct *p = commands+i;
if (strcmp(p->cmd, cmd))
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: Support "git cmd --help" syntax
2006-04-15 18:13 Support "git cmd --help" syntax Linus Torvalds
@ 2006-04-15 20:54 ` Junio C Hamano
2006-04-15 21:07 ` Linus Torvalds
0 siblings, 1 reply; 5+ messages in thread
From: Junio C Hamano @ 2006-04-15 20:54 UTC (permalink / raw)
To: Linus Torvalds; +Cc: git
Linus Torvalds <torvalds@osdl.org> writes:
> However, as anybody who has ever used CVS or some similar devil-spawn
> program, it's confusing as h*ll when options before the sub-command act
> differently from options after the sub-command, so this quick hack just
> makes it acceptable to do "git cmd --help" instead, and get the exact same
> result.
>
> It may be hacky, but it's simple and does the trick.
Tried "git commit --help" with and without the patch?
I am not sure if we want to "help" migrants from CVS or some
similar program by shooting ourselves in the foot.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Support "git cmd --help" syntax
2006-04-15 20:54 ` Junio C Hamano
@ 2006-04-15 21:07 ` Linus Torvalds
2006-04-16 1:24 ` Junio C Hamano
2006-04-19 21:40 ` Jakub Narebski
0 siblings, 2 replies; 5+ messages in thread
From: Linus Torvalds @ 2006-04-15 21:07 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
On Sat, 15 Apr 2006, Junio C Hamano wrote:
>
> Tried "git commit --help" with and without the patch?
I get a usage message without the patch.
With the patch, I get the man-page.
IOW, I don't see your point.
I'd have expected that to be an improvement. You can always get the usage
message with "git commit --huh?", so it's not like you've lost anything.
Now, if you have _not_ done
make prefix=/usr/share install-doc
or similar, then yes, you get something less than helpful (along the lines
of "No manual entry for git-commit"), and I agree that we could/should
improve on that somehow.
Linus
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Support "git cmd --help" syntax
2006-04-15 21:07 ` Linus Torvalds
@ 2006-04-16 1:24 ` Junio C Hamano
2006-04-19 21:40 ` Jakub Narebski
1 sibling, 0 replies; 5+ messages in thread
From: Junio C Hamano @ 2006-04-16 1:24 UTC (permalink / raw)
To: Linus Torvalds; +Cc: git
Linus Torvalds <torvalds@osdl.org> writes:
> I'd have expected that to be an improvement. You can always get the usage
> message with "git commit --huh?", so it's not like you've lost anything.
Fair enough. I'd say I am convinced now.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Support "git cmd --help" syntax
2006-04-15 21:07 ` Linus Torvalds
2006-04-16 1:24 ` Junio C Hamano
@ 2006-04-19 21:40 ` Jakub Narebski
1 sibling, 0 replies; 5+ messages in thread
From: Jakub Narebski @ 2006-04-19 21:40 UTC (permalink / raw)
To: git
Linus Torvalds wrote:
> [...] You can always get the usage
> message with "git commit --huh?", so it's not like you've lost anything.
Or "git commit --usage".
--
Jakub Narebski
Warsaw, Poland
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2006-04-19 21:40 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-04-15 18:13 Support "git cmd --help" syntax Linus Torvalds
2006-04-15 20:54 ` Junio C Hamano
2006-04-15 21:07 ` Linus Torvalds
2006-04-16 1:24 ` Junio C Hamano
2006-04-19 21:40 ` Jakub Narebski
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 NNTP newsgroup(s).