phylink: ReST-ify the phylink_pcs_neg_mode() kdoc
Subsystems (4)
Jakub Kicinski
maintainerPATCH 1/1 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.
---
CC: Russell King <[email protected]>
CC: [email protected]
--- include/linux/phylink.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
include/linux/phylink.h +6 -4
@@ -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 * 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. -* %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg disabled -* %PHYLINK_PCS_NEG_INBAND_ENABLED: inband mode selected and autoneg enabled +* - %PHYLINK_PCS_NEG_INBAND_DISABLED: inband mode selected but autoneg +* 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 * (e.g. Clause 37, SGMII and similar) not Clause 73.
Signature · 1 line
2.41.0
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 8 lines · On Mon, 26 Jun 2023 14:46:40 -0700 you wrote:
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.[...]
Here is the summary with links:
- [net-next] phylink: ReST-ify the phylink_pcs_neg_mode() kdoc
https://git.kernel.org/netdev/net-next/c/1a3f6fc430ed
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html