Patch "net: phylink: fix sphinx complaint about invalid literal" has been added to the 6.5-stable tree

[Sasha Levin <sashal@xxxxxxxxxx>]

This is a note to let you know that I've just added the patch titled

    net: phylink: fix sphinx complaint about invalid literal

to the 6.5-stable tree which can be found at:
    http://www.kernel.org/git/?p=linux/kernel/git/stable/stable-queue.git;a=summary

The filename of the patch is:
     net-phylink-fix-sphinx-complaint-about-invalid-liter.patch
and it can be found in the queue-6.5 subdirectory.

If you, or anyone else, feels it should not be added to the stable tree,
please let <stable@xxxxxxxxxxxxxxx> know about it.



commit a89f397ced084289cd4c27b5bd9afa6e1c3c21c5
Author: Jakub Kicinski <kuba@xxxxxxxxxx>
Date:   Tue Sep 5 16:42:02 2023 -0700

    net: phylink: fix sphinx complaint about invalid literal
    
    [ Upstream commit 1a961e74d5abbea049588a3d74b759955b4ed9d5 ]
    
    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@xxxxxxxxxxxxxxxx>
    Link: https://lore.kernel.org/all/20230626162908.2f149f98@xxxxxxxxxxxxxxxx/
    Signed-off-by: Jakub Kicinski <kuba@xxxxxxxxxx>
    Reviewed-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
    Signed-off-by: David S. Miller <davem@xxxxxxxxxxxxx>
    Signed-off-by: Sasha Levin <sashal@xxxxxxxxxx>

diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index 1817940a3418e..4dff1eba425ba 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -615,7 +615,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,
@@ -645,7 +645,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);