Skip to content

Commit

Permalink
dw-xdata-pcie: Fix documentation build warns
Browse files Browse the repository at this point in the history
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: e1181b5 ("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>
  • Loading branch information
gustavoSNPS authored and gregkh committed Apr 14, 2021
1 parent 31d8df9 commit b21a576
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
14 changes: 7 additions & 7 deletions Documentation/misc-devices/dw-xdata-pcie.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions Documentation/misc-devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ fit into other categories.
bh1770glc
eeprom
c2port
dw-xdata-pcie
ibmvmc
ics932s401
isl29003
Expand Down

0 comments on commit b21a576

Please sign in to comment.