Re: [PATCH v2] mm/swap.c: make functions and their kernel-doc agree
From: Randy Dunlap
Date: Tue Jan 30 2018 - 12:52:19 EST
On 01/30/2018 04:34 AM, Michal Hocko wrote:
> On Mon 29-01-18 16:43:55, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>>
>> Fix some basic kernel-doc notation in mm/swap.c:
>> - for function lru_cache_add_anon(), make its kernel-doc function name
>> match its function name and change colon to hyphen following the
>> function name
>
> This is pretty much an internal function to the MM. It shouldn't have
> any external callers. Why do we need a kernel doc at all?
>
>> - for function pagevec_lookup_entries(), change the function parameter
>> name from nr_pages to nr_entries since that is more descriptive of
>> what the parameter actually is and then it matches the kernel-doc
>> comments also
>
> I know what is nr_pages because I do expect pages to be returned. What
> are entries? Can it be something different from pages?
OK, never mind. I'll revisit this some other day.
later,
--
~Randy