Re: [PATCH] Add the possibility to specify a default help format

From: Jeff King <peff@peff.net>
Date: Jun 6, 2012, 13:53 UTC
Message-ID: <20120606135353.GD2597@sigill.intra.peff.net>
In-Reply-To: <1338987397-7376-1-git-send-email-vfr@lyx.org>

On Wed, Jun 06, 2012 at 12:56:37PM +0000, Vincent van Ravesteijn wrote:

Show 9 quoted lines

> At the moment, the default help format (i.e. the format that is chosen if
> 'git help xxx' is called without a help format parameter) is defined by
> the switch to be 'man'. However, on different platforms the preferred
> format might differ. For example, on Windows there is no man viewer, so we
> would prefer html.
> 
> This patch adds the possibility to choose a default help format on
> compilation by defining DEFAULT_HELP_FORMAT. If it is not specified the
> default is still 'man'.

Makes sense to me.

> ---
>  builtin/help.c |    8 +++++++-
>  1 files changed, 7 insertions(+), 1 deletions(-)

Should there be some minor infrastructure in the Makefile so you can do:

  make DEFAULT_HELP_FORMAT=man

rather than:

  make CFLAGS='-DDEFAULT_HELP_FORMAT=\"man\"'

(and the Makefile would be a good place to advertise this build knob, too)?

-Peff