git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Jon Seymour <jon.seymour@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] Add --info-path and --man-path options to git.
Date: Sun, 1 May 2011 19:25:35 -0500	[thread overview]
Message-ID: <20110502002535.GE11550@elie> (raw)
In-Reply-To: <7v62puq8a5.fsf@alter.siamese.dyndns.org>

Junio C Hamano wrote:
> Jonathan Nieder <jrnieder@gmail.com> writes:

>> The usual
>> interface to git's documentation through a man browser is not
>>
>> 	man /usr/share/man/man1/git-add.1.gz
>>
>> but
>>
>> 	man git-add;	# or "man git add" if your man viewer supports it
>
> I think you are forgetting the case where the git-man-path the user uses
> to install git may be outside /usr/share/man (e.g. $HOME/share/man).  In
> such an installation, by setting $PATH to include your installed git
> binary (e.g. $HOME/bin), you should be able to say "git help -m git" to
> tell help.c to internally prepend $HOME/share/man to the $MANPATH before
> it kicks "man".

I was not forgetting it, but you are right that we have an opportunity
to be more helpful in that case.  (My own MANPATH already includes
~/share/man, but I can see that it is easy to forget to add.)

I am still not very happy about it.  The man browser is in a much
better position to help: the default MANPATH (at least under Debian;
see manpath(5)[1]) is generated by mapping $PATH entries on the fly, and
it seems like only an oversight that it deals with directories under
/usr but not /home.  And it does not thrill me that we would be
training people that

	git help git

will cover for the installer's mistakes, while the more conventional

	man git

mechanism (which is also used for other programs installed to $HOME)
will not.

> Isn't that what this patch is solving?

I find the "use the right version of help when multiple copies of git"
use case compelling enough already.  Please don't mind my complaints
too much.

Thanks for clarifying.
Jonathan

[1] http://man.he.net/man5/manpath

  parent reply	other threads:[~2011-05-02  0:25 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-01  8:16 [PATCH] Add --info-path and --man-path options to git Jon Seymour
2011-05-01 18:15 ` Junio C Hamano
2011-05-01 22:47   ` Jon Seymour
2011-05-01 23:48   ` Jonathan Nieder
2011-05-01 23:53     ` Jonathan Nieder
2011-05-02  0:02     ` Junio C Hamano
2011-05-02  0:06       ` Jon Seymour
2011-05-02  0:12         ` Jon Seymour
2011-05-02  0:25       ` Jonathan Nieder [this message]
2011-05-02  3:47         ` Junio C Hamano
2011-05-02  5:15           ` Jonathan Nieder
2011-05-02  6:07 ` [PATCH] Documentation: clarify meaning of --html-path, --man-path, and --info-path Jonathan Nieder
2011-05-02  6:49   ` Jon Seymour
2011-05-02 17:24   ` 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=20110502002535.GE11550@elie \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jon.seymour@gmail.com \
    /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).