From: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>
To: git@vger.kernel.org
Subject: Re: Suggestion: "man git clone"
Date: Fri, 22 Aug 2008 13:02:57 +0200 [thread overview]
Message-ID: <g8m6d1$7nf$1@ger.gmane.org> (raw)
In-Reply-To: <48ACB29C.7000606@zytor.com>
H. Peter Anvin venit, vidit, dixit 21.08.2008 02:11:
> 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
next prev parent reply other threads:[~2008-08-22 11:04 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-08-21 0:11 Suggestion: "man git clone" H. Peter Anvin
2008-08-21 0:25 ` "Peter Valdemar Mørch (Lists)"
2008-08-21 16:37 ` H. Peter Anvin
2008-08-21 17:07 ` Avery Pennarun
2008-08-21 17:22 ` H. Peter Anvin
2008-08-21 17:38 ` Jeff King
2008-08-21 20:13 ` Jeff King
2008-08-21 20:14 ` H. Peter Anvin
2008-08-21 20:18 ` Jeff King
2008-08-21 17:52 ` Bert Wesarg
2008-08-22 11:37 ` A Large Angry SCM
2008-08-21 21:49 ` Federico Lucifredi
2008-08-21 23:07 ` H. Peter Anvin
2008-08-22 0:07 ` Federico Lucifredi
2008-08-22 0:40 ` Jeff King
2008-08-22 0:42 ` Jeff King
2008-08-22 1:15 ` Miklos Vajna
2008-08-22 1:21 ` Jeff King
2008-08-22 1:21 ` Federico Lucifredi
2008-08-22 1:19 ` Federico Lucifredi
2009-06-28 2:34 ` Colin Watson
2009-07-06 2:48 ` Federico Lucifredi
2009-07-06 4:11 ` Federico Lucifredi
2008-09-04 2:22 ` Federico Lucifredi
2008-09-04 3:31 ` H. Peter Anvin
2008-08-22 11:02 ` Michael J Gruber [this message]
2008-08-22 15:03 ` Derek Fawcus
2008-08-22 15:53 ` Mikael Magnusson
2008-08-25 12:38 ` Matthieu Moy
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='g8m6d1$7nf$1@ger.gmane.org' \
--to=michaeljgruber+gmane@fastmail.fm \
--cc=git@vger.kernel.org \
/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.
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).