linux-kernel - [PATCH] bitmap.h: fix kernel-doc warning and typo

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>] [day] [month] [year] [list]

Message-ID: <0729ea7a-2c0d-b2c5-7dd3-3629ee0803e2@infradead.org>
Date:   Tue, 8 Oct 2019 13:42:02 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     LKML <linux-kernel@...r.kernel.org>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Thomas Gleixner <tglx@...utronix.de>
Subject: [PATCH] bitmap.h: fix kernel-doc warning and typo

From: Randy Dunlap <rdunlap@...radead.org>

Fix kernel-doc warning in <linux/bitmap.h>:

../include/linux/bitmap.h:341: warning: Function parameter or member 'nbits' not described in 'bitmap_or_equal'

Also fix small typo (bitnaps).

Fixes: b9fa6442f704 ("cpumask: Implement cpumask_or_equal()")
Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Thomas Gleixner <tglx@...utronix.de>
Cc: Andrew Morton <akpm@...ux-foundation.org>
---
 include/linux/bitmap.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20191008.orig/include/linux/bitmap.h
+++ linux-next-20191008/include/linux/bitmap.h
@@ -326,10 +326,11 @@ static inline int bitmap_equal(const uns
 }
 
 /**
- * bitmap_or_equal - Check whether the or of two bitnaps is equal to a third
+ * bitmap_or_equal - Check whether the or of two bitmaps is equal to a third
  * @src1:	Pointer to bitmap 1
  * @src2:	Pointer to bitmap 2 will be or'ed with bitmap 1
  * @src3:	Pointer to bitmap 3. Compare to the result of *@...1 | *@...2
+ * @nbits:	number of bits in each of these bitmaps
  *
  * Returns: True if (*@...1 | *@...2) == *@...3, false otherwise
  */