diff mbox series

[net-next,2/2] Documentation: ACPI: DSD: fix block code comments

Message ID 20210617155552.1776011-3-ciorneiioana@gmail.com (mailing list archive)
State Accepted
Commit 5a336f97f1f5011cdca5467ef96372fd6d2fd128
Delegated to: Netdev Maintainers
Headers show
Series Documentation: ACPI: DSD: fix some build warnings | expand

Checks

Context Check Description
netdev/cover_letter success Link
netdev/fixes_present success Link
netdev/patch_count success Link
netdev/tree_selection success Clearly marked for net-next
netdev/subject_prefix success Link
netdev/cc_maintainers warning 1 maintainers not CCed: linux-acpi@vger.kernel.org
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Link
netdev/module_param success Was 0 now: 0
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/verify_fixes success Link
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 39 lines checked
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/header_inline success Link

Commit Message

Ioana Ciornei June 17, 2021, 3:55 p.m. UTC
From: Ioana Ciornei <ioana.ciornei@nxp.com>

Use the '.. code-block:: none' to properly highlight the documented DSDT
entries. This also fixes warnings in the documentation build process.

Fixes: e71305acd81c ("Documentation: ACPI: DSD: Document MDIO PHY")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
---
 Documentation/firmware-guide/acpi/dsd/phy.rst | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/firmware-guide/acpi/dsd/phy.rst b/Documentation/firmware-guide/acpi/dsd/phy.rst
index 7d01ae8b3cc6..0d49bad2ea9c 100644
--- a/Documentation/firmware-guide/acpi/dsd/phy.rst
+++ b/Documentation/firmware-guide/acpi/dsd/phy.rst
@@ -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) {
@@ -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) {
@@ -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) {
@@ -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 () {