Re: [PATCH 1/1] add: use advise function to display hints

From: Junio C Hamano <gitster@pobox.com>
To: Heba Waly <heba.waly@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>,
	Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Subject: Re: [PATCH 1/1] add: use advise function to display hints
Date: Tue, 07 Jan 2020 08:35:54 -0800	[thread overview]
Message-ID: <xmqqd0bv6x79.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <CACg5j27ce5BfR9RKekMEXokvCnXiXzmCVsyEKce+HORe8kL_GQ@mail.gmail.com> (Heba Waly's message of "Tue, 7 Jan 2020 23:54:04 +1300")

Heba Waly <heba.waly@gmail.com> writes:

> On Fri, Jan 3, 2020 at 11:48 AM Junio C Hamano <gitster@pobox.com> wrote:
>>
>> Junio C Hamano <gitster@pobox.com> writes:
>>
>> A side note.
>>
>> Right now, the advise() API is a bit awkweard to use correctly.
>> When introducing a new advice message, you would
>>
>>  * come up with advice.frotz configuration variable
>>
>>  * define and declare advice_frotz global variable that defaults to
>>    true
>>
>>  * sprinkle calls like this:
>>
>>         if (advice_frotz)
>>                 advise(_("helpful message about frotz"));
>>
>> I am wondering about two things:
>>
>>  (1) if we can update the API so that the above can be reduced to
>>      just adding calls like:
>>
>>         advise_ng("frotz", _("helpful message about frotz"));
>>
>>  (2) if such a simplified advise_ng API is a good idea to begin
>>      with.
>>
>
> That's a valid suggestion, I can investigate that in a new patch, I'd rather
> keep this one as simple as calling the existing advise function.

Yeah, the side note wasn't even a suggestion for improving _this_
topic, nor even specifically addressed to you.  Let's stay focused.

Thanks.