]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
string: fix kerneldoc formatting in strends()
authorBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Tue, 18 Nov 2025 10:04:03 +0000 (11:04 +0100)
committerBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Thu, 20 Nov 2025 13:28:35 +0000 (14:28 +0100)
strends() kernel doc should have used `@str:` format for arguments
instead of `@str -`.

Fixes: 197b3f3c70d6 ("string: provide strends()")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/all/20251118134748.40f03b9c@canb.auug.org.au/
Link: https://lore.kernel.org/r/20251118-strends-follow-up-v1-1-d3f8ef750f59@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
include/linux/string.h

index 929d05d1247c76eb9011fe34250b487834b2d3c9..69e9256592f87e446d6f0be5034056aa7d0b78b0 100644 (file)
@@ -564,8 +564,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.