Re: [PATCH v2] doc: option value may be separate for valid reasons

[Junio C Hamano <gitster@pobox.com>]

Eric Sunshine <sunshine@sunshineco.com> writes:

> On Sun, Nov 24, 2024 at 10:14 PM Junio C Hamano <gitster@pobox.com> wrote:
>> Even though `git help cli` recommends users to prefer using
>> "--option=value" over "--option value", there can be reasons why
>> giving them separately is a good idea.  One reason is that shells do
>> not perform tilde expansion for `--option=~/path/name` but they
>> expand `--options ~/path/name` just fine.
>>
>> This is not a problem for many options whose option parsing is
>> properly written using OPT_FILENAME(), because the value given to
>> OPT_FILENAME() is tilde-expanded internally by us, but some commands
>> take a pathname as a mere string, which needs this trick to have the
>> shell help us.
>>
>> I think the reason we originally decided to recommend the stuck form
>> was because an option that takes an optional value requires you to
>> use it in the stuck form, and it is one less thing for users to
>> worry about if they get into the habit to always use the stuck form.
>> But we should be discouraging ourselves from adding an option with
>> an optional value in the first place, and we might want to weaken
>> the current recommendation.
>>
>> In any case, let's describe this one case where it is necessary to
>> use the separate form, with an example.
>>
>> Signed-off-by: Junio C Hamano <gitster@pobox.com>
>
> v2 looks good to me.

Thanks.