Skip to content

Commit 9c11cc7

Browse files
jacob-kellerdavem330
authored andcommitted
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]> Signed-off-by: David S. Miller <[email protected]>
1 parent 1d01145 commit 9c11cc7

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

Documentation/networking/devlink/devlink-region.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ example usage
3434
$ devlink region show [ DEV/REGION ]
3535
$ devlink region del DEV/REGION snapshot SNAPSHOT_ID
3636
$ devlink region dump DEV/REGION [ snapshot SNAPSHOT_ID ]
37-
$ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ]
38-
address ADDRESS length length
37+
$ devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ] address ADDRESS length length
3938
4039
# Show all of the exposed regions with region sizes:
4140
$ devlink region show
@@ -56,8 +55,7 @@ example usage
5655
0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5
5756
5857
# Read a specific part of a snapshot:
59-
$ devlink region read pci/0000:00:05.0/fw-health snapshot 1 address 0
60-
length 16
58+
$ devlink region read pci/0000:00:05.0/fw-health snapshot 1 address 0 length 16
6159
0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
6260
6361
As regions are likely very device or driver specific, no generic regions are

Documentation/networking/devlink/ice.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ Users can request an immediate capture of a snapshot via the
9090
0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc
9191
0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5
9292
93-
$ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0
94-
length 16
93+
$ devlink region read pci/0000:01:00.0/nvm-flash snapshot 1 address 0 length 16
9594
0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
9695
9796
$ devlink region delete pci/0000:01:00.0/nvm-flash snapshot 1

0 commit comments

Comments
 (0)