linux-kernel - Re: [PATCH v2] mm/swap.c: make functions and their kernel-doc agree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20180130123400.GD26445@dhcp22.suse.cz>
Date:   Tue, 30 Jan 2018 13:34:00 +0100
From:   Michal Hocko <mhocko@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Linux MM <linux-mm@...ck.org>,
        Andrew Morton <akpm@...ux-foundation.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Matthew Wilcox <willy@...radead.org>, Jan Kara <jack@...e.cz>
Subject: Re: [PATCH v2] mm/swap.c: make functions and their kernel-doc agree

On Mon 29-01-18 16:43:55, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@...radead.org>
> 
> 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?
-- 
Michal Hocko
SUSE Labs