[PATCH net] net: phylink: fix sphinx complaint about invalid literal

[PATCH net] net: phylink: fix sphinx complaint about invalid literal

[Jakub Kicinski]

sphinx complains about the use of "%PHYLINK_PCS_NEG_*":

Documentation/networking/kapi:144: ./include/linux/phylink.h:601: WARNING: Inline literal start-string without end-string.
Documentation/networking/kapi:144: ./include/linux/phylink.h:633: WARNING: Inline literal start-string without end-string.

These are not valid symbols so drop the '%' prefix.

Alternatively we could use %PHYLINK_PCS_NEG_\* (escape the *)
or use normal literal ``PHYLINK_PCS_NEG_*`` but there is already
a handful of un-adorned DEFINE_* in this file.

Fixes: f99d471afa03 ("net: phylink: add PCS negotiation mode")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/all/20230626162908.2f149f98@canb.auug.org.au/
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
CC: linux@armlinux.org.uk
CC: rmk+kernel@armlinux.org.uk
---
 include/linux/phylink.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index 7d07f8736431..2b886ea654bb 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -600,7 +600,7 @@ void pcs_get_state(struct phylink_pcs *pcs,
  *
  * The %neg_mode argument should be tested via the phylink_mode_*() family of
  * functions, or for PCS that set pcs->neg_mode true, should be tested
- * against the %PHYLINK_PCS_NEG_* definitions.
+ * against the PHYLINK_PCS_NEG_* definitions.
  */
 int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,
 	       phy_interface_t interface, const unsigned long *advertising,
@@ -630,7 +630,7 @@ void pcs_an_restart(struct phylink_pcs *pcs);
  *
  * The %mode argument should be tested via the phylink_mode_*() family of
  * functions, or for PCS that set pcs->neg_mode true, should be tested
- * against the %PHYLINK_PCS_NEG_* definitions.
+ * against the PHYLINK_PCS_NEG_* definitions.
  */
 void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode,
 		 phy_interface_t interface, int speed, int duplex);
-- 
2.41.0

Re: [PATCH net] net: phylink: fix sphinx complaint about invalid literal

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1325 bytes --]

On Tue, Sep 05, 2023 at 04:42:02PM -0700, Jakub Kicinski wrote:
> diff --git a/include/linux/phylink.h b/include/linux/phylink.h
> index 7d07f8736431..2b886ea654bb 100644
> --- a/include/linux/phylink.h
> +++ b/include/linux/phylink.h
> @@ -600,7 +600,7 @@ void pcs_get_state(struct phylink_pcs *pcs,
>   *
>   * The %neg_mode argument should be tested via the phylink_mode_*() family of
>   * functions, or for PCS that set pcs->neg_mode true, should be tested
> - * against the %PHYLINK_PCS_NEG_* definitions.
> + * against the PHYLINK_PCS_NEG_* definitions.
>   */
>  int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,
>  	       phy_interface_t interface, const unsigned long *advertising,
> @@ -630,7 +630,7 @@ void pcs_an_restart(struct phylink_pcs *pcs);
>   *
>   * The %mode argument should be tested via the phylink_mode_*() family of
>   * functions, or for PCS that set pcs->neg_mode true, should be tested
> - * against the %PHYLINK_PCS_NEG_* definitions.
> + * against the PHYLINK_PCS_NEG_* definitions.
>   */
>  void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode,
>  		 phy_interface_t interface, int speed, int duplex);

The fix LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH net] net: phylink: fix sphinx complaint about invalid literal

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by David S. Miller <davem@davemloft.net>:

On Tue,  5 Sep 2023 16:42:02 -0700 you wrote:
> sphinx complains about the use of "%PHYLINK_PCS_NEG_*":
> 
> Documentation/networking/kapi:144: ./include/linux/phylink.h:601: WARNING: Inline literal start-string without end-string.
> Documentation/networking/kapi:144: ./include/linux/phylink.h:633: WARNING: Inline literal start-string without end-string.
> 
> These are not valid symbols so drop the '%' prefix.
> 
> [...]

Here is the summary with links:
  - [net] net: phylink: fix sphinx complaint about invalid literal
    https://git.kernel.org/netdev/net/c/1a961e74d5ab

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html