ich777/linux_media
1
0
Fork 0
mirror of https://github.com/tbsdtv/linux_media.git synced 2025-07-23 12:43:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

phylink: ReST-ify the phylink_pcs_neg_mode() kdoc

Browse Source 
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>
This commit is contained in:
Jakub Kicinski
2023-06-26 14:46:40 -07:00
parent 5da4d7b8e6
commit 1a3f6fc430
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/linux/phylink.h
View File

@@ -105,11 +105,13 @@ static inline bool phylink_autoneg_inband(unsigned int mode)
* *
* Determines the negotiation mode to be used by the PCS, and returns * Determines the negotiation mode to be used by the PCS, and returns
* one of: * one of:
* %PHYLINK_PCS_NEG_NONE: interface mode does not support inband *
* %PHYLINK_PCS_NEG_OUTBAND: an out of band mode (e.g. reading the PHY) * - %PHYLINK_PCS_NEG_NONE: interface mode does not support inband
* - %PHYLINK_PCS_NEG_OUTBAND: an out of band mode (e.g. reading the PHY)
* will be used. * will be used.
* %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg disabled * - %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg
* %PHYLINK_PCS_NEG_INBAND_ENABLED: inband mode selected and autoneg enabled * disabled
* - %PHYLINK_PCS_NEG_INBAND_ENABLED: inband mode selected and autoneg enabled
* *
* Note: this is for cases where the PCS itself is involved in negotiation * Note: this is for cases where the PCS itself is involved in negotiation
* (e.g. Clause 37, SGMII and similar) not Clause 73. * (e.g. Clause 37, SGMII and similar) not Clause 73.