Skip to content

Commit 1a961e7

Browse files
kuba-moodavem330
authored andcommitted
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: f99d471 ("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>
1 parent f8fdd54 commit 1a961e7

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/linux/phylink.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ void pcs_get_state(struct phylink_pcs *pcs,
600600
*
601601
* The %neg_mode argument should be tested via the phylink_mode_*() family of
602602
* functions, or for PCS that set pcs->neg_mode true, should be tested
603-
* against the %PHYLINK_PCS_NEG_* definitions.
603+
* against the PHYLINK_PCS_NEG_* definitions.
604604
*/
605605
int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,
606606
phy_interface_t interface, const unsigned long *advertising,
@@ -630,7 +630,7 @@ void pcs_an_restart(struct phylink_pcs *pcs);
630630
*
631631
* The %mode argument should be tested via the phylink_mode_*() family of
632632
* functions, or for PCS that set pcs->neg_mode true, should be tested
633-
* against the %PHYLINK_PCS_NEG_* definitions.
633+
* against the PHYLINK_PCS_NEG_* definitions.
634634
*/
635635
void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode,
636636
phy_interface_t interface, int speed, int duplex);

0 commit comments

Comments
 (0)