Linux Hardening
 help / color / mirror / Atom feed
* [PATCH] overflow: Fix kernel-doc typos in overflows_type and __set_flex_counter
@ 2026-05-03 13:48 Sang-Heon Jeon
  0 siblings, 0 replies; only message in thread
From: Sang-Heon Jeon @ 2026-05-03 13:48 UTC (permalink / raw)
  To: kees, gustavoars; +Cc: linux-hardening, Sang-Heon Jeon

Replace stale @x reference with @n in overflows_type() kernel-doc,
and fix "annoated" -> "annotated" in __set_flex_counter() kernel-doc.

Signed-off-by: Sang-Heon Jeon <ekffu200098@gmail.com>
---
Hello,

I found these minor typos while reading the code. The change is trivial,
but I hope it helps reduce a bit of confusion for future readers.

Best Regards,
Sang-Heon Jeon
---
 include/linux/overflow.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/include/linux/overflow.h b/include/linux/overflow.h
index a8cb6319b4fb..ec279c8c637b 100644
--- a/include/linux/overflow.h
+++ b/include/linux/overflow.h
@@ -218,11 +218,11 @@ static __always_inline bool __must_check __must_check_overflow(bool overflow)
  *		    or data type
  *
  * @n: source constant value or variable to be checked
- * @T: destination variable or data type proposed to store @x
+ * @T: destination variable or data type proposed to store @n
  *
- * Compares the @x expression for whether or not it can safely fit in
- * the storage of the type in @T. @x and @T can have different types.
- * If @x is a constant expression, this will also resolve to a constant
+ * Compares the @n expression for whether or not it can safely fit in
+ * the storage of the type in @T. @n and @T can have different types.
+ * If @n is a constant expression, this will also resolve to a constant
  * expression.
  *
  * Returns: true if overflow can occur, false otherwise.
@@ -574,7 +574,7 @@ static __always_inline size_t __must_check size_sub(size_t minuend, size_t subtr
 
 /**
  * __set_flex_counter() - Set the counter associated with the given flexible
- *                        array member that has been annoated by __counted_by().
+ *                        array member that has been annotated by __counted_by().
  * @FAM: Instance of flexible array member within a given struct.
  * @COUNT: Value to store to the __counted_by annotated @FAM_PTR's counter.
  *
-- 
2.43.0


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2026-05-03 13:48 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-05-03 13:48 [PATCH] overflow: Fix kernel-doc typos in overflows_type and __set_flex_counter Sang-Heon Jeon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox