Skip to content

Commit

Permalink
Documentation: ACPI: DSD: fix block code comments
Browse files Browse the repository at this point in the history
Use the '.. code-block:: none' to properly highlight the documented DSDT
entries. This also fixes warnings in the documentation build process.

Fixes: e71305a ("Documentation: ACPI: DSD: Document MDIO PHY")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
Ioana Ciornei authored and David S. Miller committed Jun 18, 2021
1 parent 79ab2b3 commit 5a336f9
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions Documentation/firmware-guide/acpi/dsd/phy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ network interfaces that have PHYs connected to MAC via MDIO bus.
During the MDIO bus driver initialization, PHYs on this bus are probed
using the _ADR object as shown below and are registered on the MDIO bus.

::
.. code-block:: none
Scope(\_SB.MDI0)
{
Device(PHY1) {
Expand Down Expand Up @@ -60,7 +61,9 @@ component (PHYs on the MDIO bus).
a) Silicon Component
This node describes the MDIO controller, MDI0
---------------------------------------------
::

.. code-block:: none
Scope(_SB)
{
Device(MDI0) {
Expand All @@ -80,7 +83,9 @@ This node describes the MDIO controller, MDI0
b) Platform Component
The PHY1 and PHY2 nodes represent the PHYs connected to MDIO bus MDI0
---------------------------------------------------------------------
::

.. code-block:: none
Scope(\_SB.MDI0)
{
Device(PHY1) {
Expand All @@ -98,7 +103,9 @@ DSDT entries representing MAC nodes
Below are the MAC nodes where PHY nodes are referenced.
phy-mode and phy-handle are used as explained earlier.
------------------------------------------------------
::

.. code-block:: none
Scope(\_SB.MCE0.PR17)
{
Name (_DSD, Package () {
Expand Down

0 comments on commit 5a336f9

Please sign in to comment.