Re: [PATCH 2/3] config: set help text for --bool-or-int

From: Jeff King <peff@peff.net>
Date: Mar 7, 2009, 22:48 UTC
Message-ID: <20090307224807.GA18548@coredump.intra.peff.net>
In-Reply-To: <94a0d4530903071307p46092810rb1637bfc853ee4d1@mail.gmail.com>

On Sat, Mar 07, 2009 at 11:07:46PM +0200, Felipe Contreras wrote:

Show 9 quoted lines

> On Sat, Mar 7, 2009 at 7:14 PM, Jeff King <peff@peff.net> wrote:
> > The conversion to parse_opt left this as NULL; on glibc
> > systems, the usage message prints
> >
> >   --bool-or-int   (null)
> >
> > and on other ones, segfaults.
> 
> Shouldn't then OPT_BIT make sure there is no crash?

Perhaps, but it doesn't (and I assume you mean usage_with_help, as OPT_BIT is just filling in the struct). It's not clear what a NULL help parameter should do, though. Hide the option? Show no help description? There are already ways to accomplish both of those.

> I was surprised when it didn't complain. I thought on making it "" but
> I wanted to make it visible that there was no documentation for that,
> which is the reason I left it that way.

OK. I think there are really valid options:

  1. it's there with a description (which is what my patch does)

  2. it's there without a description, because it's obvious what it does
     coming after --bool and --int

  3. it's hidden

I really don't care which. But what is there now is broken.

-Peff