Re: [PATCH] Documentation: help: describe 'man.viewer' config variable.

From: Christian Couder <chriscool@tuxfamily.org>
Date: Feb 28, 2008, 03:51 UTC
Message-ID: <200802280451.08728.chriscool@tuxfamily.org>
In-Reply-To: <200802271323.m1RDNGTR025557@mi1.bluebottle.com>

Le mercredi 27 février 2008, しらいしななこ a écrit :

Show 15 quoted lines

> Quoting Christian Couder <chriscool@tuxfamily.org>:
> > +man.viewer::
> > +	Specify the program that will be used to display help in the
> > +	'man' format. See linkgit:git-help[1].
> > +
> >  -i|--info::
> > -	Use the 'info' program to display the manual page, instead of
> > -	the 'man' program that is used by default.
> > +	Display manual documentation about the command in Info
> > +	format. The 'info' program will be used for that purpose.
>
> I am not a native speaker of the English language, but "manual
> documentation about" feels duplicatedly redundant, at least to me.  I
> think it is more common to say "the manual page for", or "the man page
> for".

Yes, I will send an updated patch saying "manual page for" soon.

Show 7 quoted lines

> >  -m|--man::
> > -	Use the 'man' program to display the manual page. This may be
> > -	used to override a value set in the 'help.format'
> > -	configuration variable.
> > +	Display manual documentation about the command in Man format.
>
> An earlier description for man.viewer says "in the 'man' format".

Ok, it will say "'man' format" everywhere.

Show 14 quoted lines

> > +	This option may be used to override a value set in the
> > +	'help.format' configuration variable.
> > ++
> > +By default the 'man' program will be used to display the man pages,
>
> And this part says "the man pages".
>
> >  -w|--web::
> > -	Use a web browser to display the HTML manual page, instead of
> > -	the 'man' program that is used by default.
> > +	Display manual documentation about the command in HTLM format.
> > +	A web browser will be used for that purpose.
>
> Is this a mistyped "HTML format"?

Right, it will be fixed.

Thanks, Christian.