Skip to content

Commit

Permalink
doc: sfp-phylink: Fix a broken reference
Browse files Browse the repository at this point in the history
The commit in Fixes: has changed a .txt file into a .yaml file. Update the
documentation accordingly.

While at it add some `` around some file names to improve the output.

Fixes: 70991f1 ("dt-bindings: net: convert sff,sfp to dtschema")
Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
Link: https://lore.kernel.org/r/be3c7e87ca7f027703247eccfe000b8e34805094.1659247114.git.christophe.jaillet@wanadoo.fr
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
  • Loading branch information
tititiou36 authored and kuba-moo committed Aug 3, 2022
1 parent 9017462 commit 6f63d04
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Documentation/networking/sfp-phylink.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ this documentation.
The :c:func:`validate` method should mask the supplied supported mask,
and ``state->advertising`` with the supported ethtool link modes.
These are the new ethtool link modes, so bitmask operations must be
used. For an example, see drivers/net/ethernet/marvell/mvneta.c.
used. For an example, see ``drivers/net/ethernet/marvell/mvneta.c``.

The :c:func:`mac_link_state` method is used to read the link state
from the MAC, and report back the settings that the MAC is currently
Expand All @@ -224,7 +224,7 @@ this documentation.
function should modify the state and only take the link down when
absolutely necessary to change the MAC configuration. An example
of how to do this can be found in :c:func:`mvneta_mac_config` in
drivers/net/ethernet/marvell/mvneta.c.
``drivers/net/ethernet/marvell/mvneta.c``.

For further information on these methods, please see the inline
documentation in :c:type:`struct phylink_mac_ops <phylink_mac_ops>`.
Expand Down Expand Up @@ -281,4 +281,4 @@ as necessary.

For information describing the SFP cage in DT, please see the binding
documentation in the kernel source tree
``Documentation/devicetree/bindings/net/sff,sfp.txt``
``Documentation/devicetree/bindings/net/sff,sfp.yaml``.

0 comments on commit 6f63d04

Please sign in to comment.