Re: [PATCH v2] remote: prefetch config

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 5, 2024, 17:54 UTC
Message-ID: <xmqq1q1y2dgm.fsf@gitster.g>
In-Reply-To: <CAG=Um+0P8SgWo2sN3St8+PpBneQfDBoqnpnC6uMmYu2YOOaWmQ@mail.gmail.com>

Shubham Kanodia <shubham.kanodia10@gmail.com> writes:

Show 15 quoted lines

> On Thu, Sep 5, 2024 at 10:22 PM Junio C Hamano <gitster@pobox.com> wrote:
>>
>> Shubham Kanodia <shubham.kanodia10@gmail.com> writes:
>>
>> >>
>> >>         int prefetch; /* is prefetch enabled? */
>> >>
>> > ...
>> > Updating my patch — please let me know if there's anything else I can
>> > improve here.
>>
>> Renaming the .prefetch member to .prefetch_enabled would eliminate
>> the need to add any comment on the member in the header file.
>
> Do you mean for the struct member here or also the config?

I do not think I mentioned anything about the name of the configuration variable, but if I did that was a mistake.

End-user facing configuration variables are often named after a feature that it enables or disables, so it can use the name without "enable". An int variable on the other hand can mean many other things, ranging from "how many times have we prefetched from here" to "does this remote allow prefetching?", so a more explicit name would often help.

Thanks.