Skip to content

Commit 9628e5c

Browse files
bagasmewilldeacon
bagasme
authored and
willdeacon
committed
iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
Commit 39215bb ("iommu/amd: Add documentation for AMD IOMMU debugfs support") documents debugfs ABI symbols for AMD IOMMU, but forgets to wrap examples snippets and their output in literal code blocks, hence Sphinx reports indentation warnings: Documentation/ABI/testing/debugfs-amd-iommu:31: ERROR: Unexpected indentation. [docutils] Documentation/ABI/testing/debugfs-amd-iommu:31: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] Documentation/ABI/testing/debugfs-amd-iommu:31: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] Wrap them to fix the warnings. Fixes: 39215bb ("iommu/amd: Add documentation for AMD IOMMU debugfs support") Reported-by: Stephen Rothwell <[email protected]> Closes: https://lore.kernel.org/linux-next/[email protected]/ Signed-off-by: Bagas Sanjaya <[email protected]> Acked-by: Randy Dunlap <[email protected]> Tested-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Will Deacon <[email protected]>
1 parent 39215bb commit 9628e5c

File tree

1 file changed

+72
-55
lines changed

1 file changed

+72
-55
lines changed

‎Documentation/ABI/testing/debugfs-amd-iommu

Lines changed: 72 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Description:
66
MMIO register offset for iommu<x>, and the file outputs the corresponding
77
MMIO register value of iommu<x>
88

9-
Example:
10-
$ echo "0x18" > /sys/kernel/debug/iommu/amd/iommu00/mmio
11-
$ cat /sys/kernel/debug/iommu/amd/iommu00/mmio
9+
Example::
10+
11+
$ echo "0x18" > /sys/kernel/debug/iommu/amd/iommu00/mmio
12+
$ cat /sys/kernel/debug/iommu/amd/iommu00/mmio
13+
14+
Output::
1215

13-
Output:
14-
Offset:0x18 Value:0x000c22000003f48d
16+
Offset:0x18 Value:0x000c22000003f48d
1517

1618
What: /sys/kernel/debug/iommu/amd/iommu<x>/capability
1719
Date: January 2025
@@ -21,12 +23,14 @@ Description:
2123
capability register offset for iommu<x>, and the file outputs the
2224
corresponding capability register value of iommu<x>.
2325

24-
Example:
25-
$ echo "0x10" > /sys/kernel/debug/iommu/amd/iommu00/capability
26-
$ cat /sys/kernel/debug/iommu/amd/iommu00/capability
26+
Example::
27+
28+
$ echo "0x10" > /sys/kernel/debug/iommu/amd/iommu00/capability
29+
$ cat /sys/kernel/debug/iommu/amd/iommu00/capability
30+
31+
Output::
2732

28-
Output:
29-
Offset:0x10 Value:0x00203040
33+
Offset:0x10 Value:0x00203040
3034

3135
What: /sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
3236
Date: January 2025
@@ -35,24 +39,26 @@ Description:
3539
This file is a read-only output file containing iommu<x> command
3640
buffer entries.
3741

38-
Examples:
39-
$ cat /sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
40-
41-
Output:
42-
CMD Buffer Head Offset:339 Tail Offset:339
43-
0: 00835001 10000001 00003c00 00000000
44-
1: 00000000 30000005 fffff003 7fffffff
45-
2: 00835001 10000001 00003c01 00000000
46-
3: 00000000 30000005 fffff003 7fffffff
47-
4: 00835001 10000001 00003c02 00000000
48-
5: 00000000 30000005 fffff003 7fffffff
49-
6: 00835001 10000001 00003c03 00000000
50-
7: 00000000 30000005 fffff003 7fffffff
51-
8: 00835001 10000001 00003c04 00000000
52-
9: 00000000 30000005 fffff003 7fffffff
53-
10: 00835001 10000001 00003c05 00000000
54-
11: 00000000 30000005 fffff003 7fffffff
55-
[...]
42+
Examples::
43+
44+
$ cat /sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
45+
46+
Output::
47+
48+
CMD Buffer Head Offset:339 Tail Offset:339
49+
0: 00835001 10000001 00003c00 00000000
50+
1: 00000000 30000005 fffff003 7fffffff
51+
2: 00835001 10000001 00003c01 00000000
52+
3: 00000000 30000005 fffff003 7fffffff
53+
4: 00835001 10000001 00003c02 00000000
54+
5: 00000000 30000005 fffff003 7fffffff
55+
6: 00835001 10000001 00003c03 00000000
56+
7: 00000000 30000005 fffff003 7fffffff
57+
8: 00835001 10000001 00003c04 00000000
58+
9: 00000000 30000005 fffff003 7fffffff
59+
10: 00835001 10000001 00003c05 00000000
60+
11: 00000000 30000005 fffff003 7fffffff
61+
[...]
5662

5763
What: /sys/kernel/debug/iommu/amd/devid
5864
Date: January 2025
@@ -63,19 +69,26 @@ Description:
6369
interrupt remapping table and device table.
6470

6571
Example:
72+
6673
1.
67-
$ echo 0000:01:00.0 > /sys/kernel/debug/iommu/amd/devid
68-
$ cat /sys/kernel/debug/iommu/amd/devid
74+
::
75+
76+
$ echo 0000:01:00.0 > /sys/kernel/debug/iommu/amd/devid
77+
$ cat /sys/kernel/debug/iommu/amd/devid
6978

70-
Output:
71-
0000:01:00.0
79+
Output::
80+
81+
0000:01:00.0
7282

7383
2.
74-
$ echo 01:00.0 > /sys/kernel/debug/iommu/amd/devid
75-
$ cat /sys/kernel/debug/iommu/amd/devid
84+
::
85+
86+
$ echo 01:00.0 > /sys/kernel/debug/iommu/amd/devid
87+
$ cat /sys/kernel/debug/iommu/amd/devid
88+
89+
Output::
7690

77-
Output:
78-
0000:01:00.0
91+
0000:01:00.0
7992

8093
What: /sys/kernel/debug/iommu/amd/devtbl
8194
Date: January 2025
@@ -84,12 +97,14 @@ Description:
8497
This file is a read-only output file containing the device table entry
8598
for the device ID provided in /sys/kernel/debug/iommu/amd/devid.
8699

87-
Example:
88-
$ cat /sys/kernel/debug/iommu/amd/devtbl
100+
Example::
101+
102+
$ cat /sys/kernel/debug/iommu/amd/devtbl
89103

90-
Output:
91-
DeviceId QWORD[3] QWORD[2] QWORD[1] QWORD[0] iommu
92-
0000:01:00.0 0000000000000000 20000001373b8013 0000000000000038 6000000114d7b603 iommu3
104+
Output::
105+
106+
DeviceId QWORD[3] QWORD[2] QWORD[1] QWORD[0] iommu
107+
0000:01:00.0 0000000000000000 20000001373b8013 0000000000000038 6000000114d7b603 iommu3
93108

94109
What: /sys/kernel/debug/iommu/amd/irqtbl
95110
Date: January 2025
@@ -98,17 +113,19 @@ Description:
98113
This file is a read-only output file containing valid IRT table entries
99114
for the device ID provided in /sys/kernel/debug/iommu/amd/devid.
100115

101-
Example:
102-
$ cat /sys/kernel/debug/iommu/amd/irqtbl
103-
104-
Output:
105-
DeviceId 0000:01:00.0
106-
IRT[0000] 0000000000000020 0000000000000241
107-
IRT[0001] 0000000000000020 0000000000000841
108-
IRT[0002] 0000000000000020 0000000000002041
109-
IRT[0003] 0000000000000020 0000000000008041
110-
IRT[0004] 0000000000000020 0000000000020041
111-
IRT[0005] 0000000000000020 0000000000080041
112-
IRT[0006] 0000000000000020 0000000000200041
113-
IRT[0007] 0000000000000020 0000000000800041
114-
[...]
116+
Example::
117+
118+
$ cat /sys/kernel/debug/iommu/amd/irqtbl
119+
120+
Output::
121+
122+
DeviceId 0000:01:00.0
123+
IRT[0000] 0000000000000020 0000000000000241
124+
IRT[0001] 0000000000000020 0000000000000841
125+
IRT[0002] 0000000000000020 0000000000002041
126+
IRT[0003] 0000000000000020 0000000000008041
127+
IRT[0004] 0000000000000020 0000000000020041
128+
IRT[0005] 0000000000000020 0000000000080041
129+
IRT[0006] 0000000000000020 0000000000200041
130+
IRT[0007] 0000000000000020 0000000000800041
131+
[...]

0 commit comments

Comments
 (0)