linux-kernel - Re: [PATCH] cpumask: fix typos and kernel-doc warnings in cpumask.h

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: <ZL42qItwNebssuBN@smile.fi.intel.com>
Date:   Mon, 24 Jul 2023 11:30:32 +0300
From:   Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, Yury Norov <yury.norov@...il.com>,
        Rasmus Villemoes <linux@...musvillemoes.dk>
Subject: Re: [PATCH] cpumask: fix typos and kernel-doc warnings in cpumask.h

On Sun, Jul 23, 2023 at 07:34:03PM -0700, Randy Dunlap wrote:
> Fix some punctuation (plural vs. possessive).
> Fix some abbreviations (ie. -> i.e., id -> ID).
> 
> Fix 35 warnings like this:
> include/linux/cpumask.h:161: warning: No description found for return value of 'cpumask_first'

I wouldn't explicitly change Returns -> Return, but since the latter is one
mentioned in the documentation and we have no actual Return section anyway
(means we need to touch those lines), I'm fine with that.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>

Thank you!

P.S. For out of curiosity the command line to check this is like

	scripts/kernel-doc -v -none -Wall ...

but I have no idea which one Randy used.

-- 
With Best Regards,
Andy Shevchenko