From: "Philip Oakley" <philipoakley@iee.org>
To: "Junio C Hamano" <gitster@pobox.com>,
"Matthieu Moy" <Matthieu.Moy@grenoble-inp.fr>
Cc: "Kevin Bracey" <kevin@bracey.fi>, <git@vger.kernel.org>
Subject: Re: [PATCH/RFC] Make help behaviour more consistent
Date: Mon, 11 Mar 2013 21:06:33 -0000 [thread overview]
Message-ID: <CD3017A6746B45FE8A5F242E4C597B51@PhilipOakley> (raw)
In-Reply-To: 7vppz592v5.fsf@alter.siamese.dyndns.org
From: "Junio C Hamano" <gitster@pobox.com>
Sent: Monday, March 11, 2013 7:02 PM
> Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
>
>> Kevin Bracey <kevin@bracey.fi> writes:
>>
>>> Two significant usability flaws here:
>>> - If using man, "man git" to side-step "git help" is obvious. But
>>> if
>>> trying to use help.format=web, how to get the root html page? My
>>> technique was "git help XXX" and click the "git(1) suite" link at
>>> the
>>> bottom. "git help git" is non-obvious and apparently undocumented
>>> (it's not mentioned by "git", "git help", or "git help help"...).
>>
>> Can't this be solved by adding something like
>>
>> See 'git help git' for general help about Git.
>>
>> to the output of "git help"? I think the fact that "git help"
>> provides a
>> small amount of output (typically: fits on one screen) is a nice
>> feature
>> that avoids scaring people too early with the actual doc.
>
> That sounds like a good direction to go in.
My earlier attempt, and Junio's reply
http://thread.gmane.org/gmane.comp.version-control.git/217352
It is tricky making sure that the message covers help for git, help's
own help,
the guides, and the commands, all in one compact usage line, while also
covering the -h and --help options (which may not be known to new Git
users on Windows, though probably obvious to Linux/Unix users).
Philip
next prev parent reply other threads:[~2013-03-11 21:06 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-10 17:48 [PATCH/RFC] Make help behaviour more consistent Kevin Bracey
2013-03-10 23:56 ` Philip Oakley
2013-03-11 3:03 ` Junio C Hamano
2013-03-11 18:51 ` Kevin Bracey
2013-03-11 8:13 ` Matthieu Moy
2013-03-11 19:02 ` Junio C Hamano
2013-03-11 21:06 ` Philip Oakley [this message]
2013-03-11 21:50 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CD3017A6746B45FE8A5F242E4C597B51@PhilipOakley \
--to=philipoakley@iee.org \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=kevin@bracey.fi \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.