git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andreas Ericsson <ae@op5.se>
To: Sergei Organov <osv@javad.com>
Cc: Junio C Hamano <gitster@pobox.com>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>,
	git@vger.kernel.org
Subject: Re: [PATCH] Let git-help prefer man-pages installed with this version of git
Date: Fri, 07 Dec 2007 13:38:10 +0100	[thread overview]
Message-ID: <47593EB2.3020309@op5.se> (raw)
In-Reply-To: <871w9y7mei.fsf@osv.gnss.ru>

Sergei Organov wrote:
> Junio C Hamano <gitster@pobox.com> writes:
> 
 >> Having written that, it is very tempting to further clarify the above:
>>
>>     Usually, if a user has his own version of git and regularly uses it
>>     by having the non-system executable directory (e.g. $HOME/bin/git)
>>     early in his $PATH, its corresponding documentation would also be in
>>     a non-system documentation directory (e.g. $HOME/man) early in his
>>     $MANPATH, and this change is a no-op.  The only case this change
>>     matters is where the user installs his own git outside of his $PATH
>>     and $MANPATH, and explicitly runs his git executable
>>     (e.g. "$HOME/junk/git-1.5.4/bin/git diff").
> 
> First, I don't think you need to clarify like this. It is just
> implementation detail of git-help that it uses 'man', and thus
> implicitly relies on MANPATH. The essential thing has been already
> stated above: git-help should show correct documentation.
> 
> Second, the change is still useful even if user did put custom path to
> 'git' into its PATH, but didn't even thought of customizing
> MANPATH. Besides, a user could be entirely unaware of 'man' the utility.
> 

The number of users in the entire world that are completely unaware of
the 'man' utility but still manages to build git and install it in a
non-default path can probably be counted on one hand of a 65 year old
saw-mill worker.

I'm not sure if we're doing them a greater service by DWIMing this or
by telling them about the 'man' utility.

> 
>> How typical would that use be, to run your git executable by always
>> naming it by path without relying on $PATH environment variable?
> 
> To tell the truth, I'd prefer to just use -M option of man and don't
> rely on MANPATH at all, so that 'git help' will issue error if there is
> no documentation installed for this particular version of git.
> 

Does "man -M" work everywhere, or is your patch opening a can of worms
to get probably-not-needed functionality?

Otoh, you submitted a patch, so there are probably a few people out
there that care about this. I'm not one of them, so I'll shut up now
that my lunch is over ;-)

-- 
Andreas Ericsson                   andreas.ericsson@op5.se
OP5 AB                             www.op5.se
Tel: +46 8-230225                  Fax: +46 8-230231

  reply	other threads:[~2007-12-07 12:38 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-06 18:33 [PATCH] Let git-help prefer man-pages installed with this version of git Sergei Organov
2007-12-06 20:09 ` Johannes Schindelin
2007-12-07 10:16   ` Sergei Organov
2007-12-07 10:39     ` Junio C Hamano
2007-12-07 11:51       ` Sergei Organov
2007-12-07 12:38         ` Andreas Ericsson [this message]
2007-12-07 12:49           ` Sergei Organov
2007-12-07 19:29         ` Junio C Hamano
2007-12-07 16:19       ` David Brown
2007-12-07 16:22         ` David Brown

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=47593EB2.3020309@op5.se \
    --to=ae@op5.se \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=osv@javad.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).