Re: Suggestion: "man git clone"

From: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>
Date: Aug 22, 2008, 11:02 UTC
Message-ID: <g8m6d1$7nf$1@ger.gmane.org>
In-Reply-To: <48ACB29C.7000606@zytor.com>

H. Peter Anvin venit, vidit, dixit 21.08.2008 02:11:

Show 11 quoted lines

> Given the recent change of "git-foo" to "git foo", it would be really 
> nice if one could type, for example:
> 
> 	man git clone
> 
> and actually get the man page for the git clone command.  There are 
> quite a few other pieces of software which also could benefit from that 
> kind of indirection.
> 
> Right now the above command shows the man page git(1) followed by 
> clone(2), which I believe has be classified as utterly useless behaviour...

The discussion seems to show that altering man and relying on the new behaviour is no option, and neither is playing games with man's section options.

How about:

- Change all references inside git (warnings etc) from "man git-bla" to
"git help bla".

- Change all references in the help pages (gitlinks) accordingly.

- Put a warning in the main git man page which redirects the confused
("If you were looking for the manpage of "git bla" and issued "man git
bla", please refer to "man git-bla" or "git help bla".'), maybe just
before the command list there.

This could be supported by an alias mapping "git man" to "git help -m".

I've heard about some other SCMs which have only "scm help bla", so this suggestion would be in-line with common usage. [Not that git would have to learn from other SCM's ;) ]

Michael