git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Michael J Gruber <git@drmicha.warpmail.net>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>
Subject: Re: [RFC PATCH] git-help: find library man pages again
Date: Thu, 2 Sep 2010 03:55:33 -0500	[thread overview]
Message-ID: <20100902085533.GL29713@burratino> (raw)
In-Reply-To: <4C7F6354.70108@drmicha.warpmail.net>

Michael J Gruber wrote:
> Jonathan Nieder venit, vidit, dixit 02.09.2010 10:16:

>> Therefore this seems wrong to me (except as a backward-compatibility
>> measure).
[...]
> One heuristic, which I would have left for a later patch because of its
> radicality (and I think we're in some phase of some rc something), is to
> simply not do any checks when calling the viewers. This requires that
> everything is prepended with "git-", which I see you have done in
> builtin/help.c.

Yep, I agree with you in all respects, including the need to do
something else (like the patch you sent) for v1.7.3.

> Still, none-command help pages will not show up with
> "git help -a". So it's not a complete solution.

I think of "git --help -a" as a more complete version of the list
from "git --help" --- that is, it is explaining what subcommands are
available for git.

On the other hand, on platforms where "man -k git" is not available,
as you mention it is the index to the manual.  Maybe "git help" should
check GIT_HTML_PATH to provide a more complete index on such platforms.

Just musing.

> Alternatively, load_command_list() etc. could simply fill up a third
> list "other_pages" (with non-executables) so that "git help -a" could
> list "other help pages" in addition to the commands. I don't think this
> would require any renaming nor Documentation updates.

Looks like you had a similar thought.

> ??? I guess this patch makes sense only after a patch which renames all
> gitfoo.txt to git-foo.txt.

Well, there were ulterior motives to that patch: I keep on mistyping
half-hyphenated manpage names like gitcvs-migration.

I should have included some appropriate Makefile magic for
compatibility symlinks for the old names.  Hopefully at least the idea
was clear.

  reply	other threads:[~2010-09-02  8:57 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-09-01 16:02 [RFC PATCH] git-help: find library man pages again Michael J Gruber
2010-09-01 16:07 ` Michael J Gruber
2010-09-02  8:16 ` Jonathan Nieder
2010-09-02  8:41   ` Michael J Gruber
2010-09-02  8:55     ` Jonathan Nieder [this message]
2010-09-02  9:09       ` Michael J Gruber
2010-09-09 19:58     ` Jeff King

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=20100902085533.GL29713@burratino \
    --to=jrnieder@gmail.com \
    --cc=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /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).