linux-kernel - [PATCH] string: Fix missing kernel-doc descriptions in string.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-next>] [day] [month] [year] [list]

Message-Id: <20251118180008.2620929-1-kriish.sharma2006@gmail.com>
Date: Tue, 18 Nov 2025 18:00:08 +0000
From: Kriish Sharma <kriish.sharma2006@...il.com>
To: kees@...nel.org,
	andy@...nel.org
Cc: linux-hardening@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Kriish Sharma <kriish.sharma2006@...il.com>
Subject: [PATCH] string: Fix missing kernel-doc descriptions in string.h

While running kernel-doc validation, several warnings were emitted for
functions in include/linux/string.h due to missing return value
documentation or missing parameter descriptions:

    Warning: include/linux/string.h:375 No description found for return value of 'kbasename'
    Warning: include/linux/string.h:560 No description found for return value of 'strstarts'
    WARNING: include/linux/string.h:573 function parameter 'str' not described in 'strends'
    WARNING: include/linux/string.h:573 function parameter 'suffix' not described in 'strends'

This patch adds the missing "Returns:" sections for kbasename() and
strstarts(), and provides parameter descriptions for strends().
These changes resolve all kernel-doc warnings in this header.

Signed-off-by: Kriish Sharma <kriish.sharma2006@...il.com>
---
 include/linux/string.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/include/linux/string.h b/include/linux/string.h
index 929d05d1247c..3597e2801463 100644
--- a/include/linux/string.h
+++ b/include/linux/string.h
@@ -371,6 +371,10 @@ static inline void memzero_explicit(void *s, size_t count)
  * kbasename - return the last part of a pathname.
  *
  * @path: path to extract the filename from.
+ *
+ * Returns:
+ * Pointer to the filename portion inside @path. If no '/' exists,
+ * returns @path unchanged.
  */
 static inline const char *kbasename(const char *path)
 {
@@ -556,6 +560,9 @@ static __always_inline size_t str_has_prefix(const char *str, const char *prefix
  * strstarts - does @str start with @prefix?
  * @str: string to examine
  * @prefix: prefix to look for.
+ *
+ * Returns:
+ * True if @str begins with @prefix. False in all other cases.
  */
 static inline bool strstarts(const char *str, const char *prefix)
 {
@@ -564,8 +571,8 @@ static inline bool strstarts(const char *str, const char *prefix)
 
 /**
  * strends - Check if a string ends with another string.
- * @str - NULL-terminated string to check against @suffix
- * @suffix - NULL-terminated string defining the suffix to look for in @str
+ * @str: NULL-terminated string to check against @suffix
+ * @suffix: NULL-terminated string defining the suffix to look for in @str
  *
  * Returns:
  * True if @str ends with @suffix. False in all other cases.
-- 
2.34.1