[PATCH v4 1/2] dw-xdata-pcie: Fix documentation build warns
From: Gustavo Pimentel
Date: Sat Apr 10 2021 - 10:53:12 EST
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
Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver")
Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@xxxxxxxxxxxxxxxx/
Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Signed-off-by: Gustavo Pimentel <gustavo.pimentel@xxxxxxxxxxxx>
---
Documentation/misc-devices/dw-xdata-pcie.rst | 14 +++++++-------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst
index fd75c93..cbc9f69 100644
--- a/Documentation/misc-devices/dw-xdata-pcie.rst
+++ b/Documentation/misc-devices/dw-xdata-pcie.rst
@@ -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
diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 64420b331..30ac58f 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -19,6 +19,7 @@ fit into other categories.
bh1770glc
eeprom
c2port
+ dw-xdata-pcie
ibmvmc
ics932s401
isl29003
--
2.7.4