Re: [PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jan 18, 2017, 20:58 UTC
- Message-ID
- <xmqqr3403x1r.fsf@gitster.mtv.corp.google.com>
- In-Reply-To
- <254445096AD0412287CBB994E8BCA043@PhilipOakley>
"Philip Oakley" <philipoakley@iee.org> writes:
Show 13 quoted lines
>>> +`OPT_STRING_LIST(short, long, &list, arg_str, description)`:: >>> + Introduce an option with string argument. >>> + The string argument is stored as an element in `&list` which must be a >>> + struct string_list. Reset the list using `--no-option`. >>> + >> >> I do not know if it is clear enough that 'option' in the last >> sentence is a placeholder. I then wondered if spelling it as >> `--no-<long>` would make it a bit clearer, but that is ugly. > > Bikeshedding:: `--no-<option>` maybe, i.e. just surround the option > word with the angle brackets to indicate it is to be replaced by the > real option's name.
Yeah, I bikeshedded that myself, and rejected it because there is no <option> mentioned anywhere in the enumeration header.