Skip to content

Commit 1a3f6fc

Browse files
committed
phylink: ReST-ify the phylink_pcs_neg_mode() kdoc
Stephen reports warnings when rendering phylink kdocs as HTML: include/linux/phylink.h:110: ERROR: Unexpected indentation. include/linux/phylink.h:111: WARNING: Block quote ends without a blank line; unexpected unindent. include/linux/phylink.h:614: WARNING: Inline literal start-string without end-string. include/linux/phylink.h:644: WARNING: Inline literal start-string without end-string. Make phylink_pcs_neg_mode() use a proper list format to fix the first two warnings. The last two warnings, AFAICT, come from the use of shorthand like phylink_mode_*(). Perhaps those should be special-cased at the Sphinx level. Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Link: https://lore.kernel.org/all/20230626162908.2f149f98@canb.auug.org.au/ Link: https://lore.kernel.org/r/20230626214640.3142252-1-kuba@kernel.org Signed-off-by: Jakub Kicinski <kuba@kernel.org>
1 parent 5da4d7b commit 1a3f6fc

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

include/linux/phylink.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,13 @@ static inline bool phylink_autoneg_inband(unsigned int mode)
105105
*
106106
* Determines the negotiation mode to be used by the PCS, and returns
107107
* one of:
108-
* %PHYLINK_PCS_NEG_NONE: interface mode does not support inband
109-
* %PHYLINK_PCS_NEG_OUTBAND: an out of band mode (e.g. reading the PHY)
108+
*
109+
* - %PHYLINK_PCS_NEG_NONE: interface mode does not support inband
110+
* - %PHYLINK_PCS_NEG_OUTBAND: an out of band mode (e.g. reading the PHY)
110111
* will be used.
111-
* %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg disabled
112-
* %PHYLINK_PCS_NEG_INBAND_ENABLED: inband mode selected and autoneg enabled
112+
* - %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg
113+
* disabled
114+
* - %PHYLINK_PCS_NEG_INBAND_ENABLED: inband mode selected and autoneg enabled
113115
*
114116
* Note: this is for cases where the PCS itself is involved in negotiation
115117
* (e.g. Clause 37, SGMII and similar) not Clause 73.

0 commit comments

Comments
 (0)