Re: [PATCH v4 1/6] string: Add strprefix(), and deprecate str_has_prefix()

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential
issue to consider:
- [Low] string: malformed kernel-doc ReST markup in strprefix() return
  comment
--

commit 8eed33304d3a2d7359bd34313832099b3feee074
Author: Alejandro Colomar <alx@kernel.org>

string: Add strprefix(), and deprecate str_has_prefix()

This commit adds the strprefix() helper returning a pointer past the
matched prefix or NULL, updates str_has_prefix()'s documentation to
reference it, and adds a KUnit test case.

Link: https://lore.kernel.org/linux-hardening/20261104-fwnode-for-each-prop-v1-1-6e28fe1c72c4@oss.qualcomm.com/

> diff --git a/include/linux/string.h b/include/linux/string.h
> index 5702daca4326b..ec6ca50599fed 100644
> --- a/include/linux/string.h
> +++ b/include/linux/string.h
> @@ -533,15 +533,33 @@ void memcpy_and_pad(void *dest, size_t dest_len, const void *src, size_t count,
>  })
>  
>  /**
> - * str_has_prefix - Test if a string has a given prefix
> - * @str: The string to test
> - * @prefix: The string to see if @str starts with
> + * strprefix - string prefix
> + * @s: The string to be tested
> + * @prefix: The string to see if @s starts with
>   *
>   * A common way to test a prefix of a string is to do:
> - *  strncmp(str, prefix, sizeof(prefix) - 1)
> + *  strncmp(s, prefix, sizeof(prefix) - 1)
>   *
>   * But this can lead to bugs due to typos, or if prefix is a pointer
> - * and not a constant. Instead use str_has_prefix().
> + * and not a constant.  Instead use strprefix().
> + *
> + * Returns:
> + * *  @s+strlen(@prefix) if @s starts with @prefix

[Severity: Low]
Does "@s+strlen(@prefix)" produce broken reStructuredText inline markup in
the documentation build?

kernel-doc expands @param references to **param**, turning this into
"**s**+strlen(**prefix**)".  Because "+" is neither whitespace nor closing
punctuation, Docutils does not treat the "**" after "s" as closing strong
emphasis and renders literal "**" characters inside the bold text.  Adding
spaces around "+" ("@s + strlen(@prefix)") avoids this.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/cover.1794425425.git.alx@kernel.org?part=1