devlink: don't wrap commands in rST shell blocks
Subsystems (4)
PATCH 1/1 devlink: don't wrap commands in rST shell blocks
The devlink-region.rst and ice-region.rst documentation files wrapped some lines within shell code blocks due to being longer than 80 lines.
It was pointed out during review that wrapping these lines shouldn't be done. Fix these two rST files and remove the line wrapping on these shell command examples.
Reported-by Jiri Pirko <[email protected]>
Signed-off-by Jacob Keller <[email protected]>
--- Documentation/networking/devlink/devlink-region.rst | 6 ++---- Documentation/networking/devlink/ice.rst | 3 +-- 2 files changed, 3 insertions(+), 6 deletions(-)
Documentation/networking/devlink/devlink-region.rst +2 -4
@@ -34,8 +34,7 @@ example usage $ devlink region show [ DEV/REGION ] $ devlink region del DEV/REGION snapshot SNAPSHOT_ID $ devlink region dump DEV/REGION [ snapshot SNAPSHOT_ID ] - $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] - address ADDRESS length length + $ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length length # Show all of the exposed regions with region sizes: $ devlink region show
@@ -56,8 +55,7 @@ example usage 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5 # Read a specific part of a snapshot: - $ devlink region read pci/0000:00:05.0/fw-health snapshot 1 address 0 - length 16 + $ devlink region read pci/0000:00:05.0/fw-health snapshot 1 address 0 length 16 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 As regions are likely very device or driver specific, no generic regions are
Documentation/networking/devlink/ice.rst +1 -2
@@ -90,8 +90,7 @@ Users can request an immediate capture of a snapshot via the 0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5 - $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 - length 16 + $ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30 $ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1
Signature · 1 line
2.24.1
From: Jacob Keller <[email protected]>
Date: Fri, 27 Mar 2020 13:55:36 -0700
Quoted 9 lines
The
devlink-region.rstandice-region.rstdocumentation files wrapped some lines within shell code blocks due to being longer than 80 lines.It was pointed out during review that wrapping these lines shouldn't be done. Fix these two rST files and remove the line wrapping on these shell command examples.
Reported-by Jiri Pirko <[email protected]>Signed-off-by Jacob Keller <[email protected]>
Applied.