Re: [PATCH] Show html help with git-help --html

From: Junio C Hamano <junkio@cox.net>
Date: Jun 4, 2007, 20:42 UTC
Message-ID: <7vvee3ih8s.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <fcaeb9bf0706040629k489d4818sa291725cbbeead79@mail.gmail.com>

"Nguyen Thai Ngoc Duy" <pclouds@gmail.com> writes:

Show 19 quoted lines

> On 6/4/07, Junio C Hamano <gitster@pobox.com> wrote:
>> > diff --git a/Documentation/config.txt b/Documentation/config.txt
>> > index 3d8f03d..2ec8545 100644
>> > --- a/Documentation/config.txt
>> > +++ b/Documentation/config.txt
>> > @@ -261,6 +261,18 @@ core.excludeFile::
>> > ...
>> > +core.htmlprogram::
>> > +     Specify the program used to open html help files when 'git-help'
>> > +     is called with option --html or core.help is other than 'man'.
>> > +     By default, xdg-open will be used.
>>
>> Is the program's calling convention something that needs to be
>> customizable for this to be useful?
>
> At first I thought xdg-open would be flexible enough for most Linux
> systems because it will choose the best browser you have. But I now
> recall that Git does not only run on Linux.  Will make it a parameter
> in config.mak.in

Actually that was not what I meant. I thought we might need to support something like:

	core.htmlprogram = grand-unified-help %b

for a program that knows where in the system the distribution keeps help HTML files, and add prefix (/usr/share/html-help/, perhaps) and suffix (obviously, .html) to the basename of the command (e.g. "grand-unified-help git-rebase" ends up running "lynx file:///usr/share/html-help/git-rebase.html"), or perhaps

	core.htmlprogram = firefox /usr/share/html-help/%f

and we substitute '%f' with "git-rebase.html".

Show 13 quoted lines

>> ...
>> > +     if (prefixcmp(git_cmd, "git"))
>> > +             strcat(p,"git-");
>> > +     strcat(p,git_cmd);
>> > +     strcat(p,".html");
>> > +
>> > +     ret = system(p);
>>
>> This is sloppy in the presense of potentially unsafe characters...
>
> I personally think users will not shoot themselves with "git help
> --html ';rm -rf'" but again scripts can. Thank you for pointing out.
> Will add check for file existence before calling system().

File existence?  I am not sure what you mean by that, sorry.