dw-xdata-pcie: Fix documentation build warns
authorGustavo Pimentel <Gustavo.Pimentel@synopsys.com>
Sat, 10 Apr 2021 14:52:58 +0000 (16:52 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 14 Apr 2021 17:47:28 +0000 (19:47 +0200)
Fixes documentation build warns related to indentation, text formatting,
and missing reference on toc.

This fix solves the following warnings:

WARNING: Unexpected indentation.
WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: document isn't included in any toctree

Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@synopsys.com>
Link: https://lore.kernel.org/r/42ed2d9d27579291dc7cce89c0164bd9255fe337.1618066164.git.gustavo.pimentel@synopsys.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/misc-devices/dw-xdata-pcie.rst
Documentation/misc-devices/index.rst

index fd75c93..cbc9f69 100644 (file)
@@ -17,24 +17,24 @@ information to /var/log/kern.log or dmesg.
 
 Request write TLPs traffic generation - Root Complex to Endpoint direction
 - Command:
-       echo 1 > /sys/class/misc/dw-xdata-pcie/write
+echo 1 > /sys/class/misc/dw-xdata-pcie/write
 
 Get write TLPs traffic link throughput in MB/s
 - Command:
-        cat /sys/class/misc/dw-xdata-pcie/write
+cat /sys/class/misc/dw-xdata-pcie/write
 - Output example:
-       204
+204
 
 Request read TLPs traffic generation - Endpoint to Root Complex direction:
 - Command:
-       echo 1 > /sys/class/misc/dw-xdata-pcie/read
+echo 1 > /sys/class/misc/dw-xdata-pcie/read
 
 Get read TLPs traffic link throughput in MB/s
 - Command:
-        cat /sys/class/misc/dw-xdata-pcie/read
+cat /sys/class/misc/dw-xdata-pcie/read
 - Output example:
-       199
+199
 
 Request to stop any current TLP transfer:
 - Command:
-       echo 1 > /sys/class/misc/dw-xdata-pcie/stop
+echo 1 > /sys/class/misc/dw-xdata-pcie/stop
index 64420b3..30ac58f 100644 (file)
@@ -19,6 +19,7 @@ fit into other categories.
    bh1770glc
    eeprom
    c2port
+   dw-xdata-pcie
    ibmvmc
    ics932s401
    isl29003