]> git.proxmox.com Git - mirror_ubuntu-kernels.git/commit
net: phylink: fix sphinx complaint about invalid literal
authorJakub Kicinski <kuba@kernel.org>
Tue, 5 Sep 2023 23:42:02 +0000 (16:42 -0700)
committerDavid S. Miller <davem@davemloft.net>
Wed, 6 Sep 2023 06:46:49 +0000 (07:46 +0100)
commit1a961e74d5abbea049588a3d74b759955b4ed9d5
treebcc6735a9d93220f565b445c529f1941f06156bf
parentf8fdd54ee6a135dbe3bb482d817ecf1ab65c53db
net: phylink: fix sphinx complaint about invalid literal

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>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/linux/phylink.h