1. Patchew
  2. linux
  3. View series

[PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks

Bagas Sanjaya posted 1 patch 2 months, 3 weeks ago 
Documentation/ABI/testing/debugfs-amd-iommu | 125 +++++++++++---------
1 file changed, 71 insertions(+), 54 deletions(-)
[PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
Posted by Bagas Sanjaya 2 months, 3 weeks ago 
Commit 39215bb3b0d929 ("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: 39215bb3b0d9 ("iommu/amd: Add documentation for AMD IOMMU debugfs support")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250716204207.73869849@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/ABI/testing/debugfs-amd-iommu | 125 +++++++++++---------
 1 file changed, 71 insertions(+), 54 deletions(-)

diff --git a/Documentation/ABI/testing/debugfs-amd-iommu b/Documentation/ABI/testing/debugfs-amd-iommu
index c14b1620aec171..5621a66aa6936a 100644
--- a/Documentation/ABI/testing/debugfs-amd-iommu
+++ b/Documentation/ABI/testing/debugfs-amd-iommu
@@ -6,12 +6,14 @@ Description:
 		MMIO register offset for iommu<x>, and the file outputs the corresponding
 		MMIO register value of iommu<x>
 
-		Example:
-		$ echo "0x18" > /sys/kernel/debug/iommu/amd/iommu00/mmio
-		$ cat /sys/kernel/debug/iommu/amd/iommu00/mmio
+		Example::
 
-		Output:
-		Offset:0x18 Value:0x000c22000003f48d
+		  $ echo "0x18" > /sys/kernel/debug/iommu/amd/iommu00/mmio
+		  $ cat /sys/kernel/debug/iommu/amd/iommu00/mmio
+
+		Output::
+
+		  Offset:0x18 Value:0x000c22000003f48d
 
 What:		/sys/kernel/debug/iommu/amd/iommu<x>/capability
 Date:		January 2025
@@ -21,12 +23,14 @@ Description:
 		capability register offset for iommu<x>, and the file outputs the
 		corresponding capability register value of iommu<x>.
 
-		Example:
-		$ echo "0x10" > /sys/kernel/debug/iommu/amd/iommu00/capability
-		$ cat /sys/kernel/debug/iommu/amd/iommu00/capability
+		Example::
 
-		Output:
-		Offset:0x10 Value:0x00203040
+		  $ echo "0x10" > /sys/kernel/debug/iommu/amd/iommu00/capability
+		  $ cat /sys/kernel/debug/iommu/amd/iommu00/capability
+
+		Output::
+
+		  Offset:0x10 Value:0x00203040
 
 What:		/sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
 Date:		January 2025
@@ -35,24 +39,26 @@ Description:
 		This file is a read-only output file containing iommu<x> command
 		buffer entries.
 
-		Examples:
-		$ cat /sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
+		Examples::
 
-		Output:
-		CMD Buffer Head Offset:339 Tail Offset:339
-		  0: 00835001 10000001 00003c00 00000000
-		  1: 00000000 30000005 fffff003 7fffffff
-		  2: 00835001 10000001 00003c01 00000000
-		  3: 00000000 30000005 fffff003 7fffffff
-		  4: 00835001 10000001 00003c02 00000000
-		  5: 00000000 30000005 fffff003 7fffffff
-		  6: 00835001 10000001 00003c03 00000000
-		  7: 00000000 30000005 fffff003 7fffffff
-		  8: 00835001 10000001 00003c04 00000000
-		  9: 00000000 30000005 fffff003 7fffffff
-		 10: 00835001 10000001 00003c05 00000000
-		 11: 00000000 30000005 fffff003 7fffffff
-		[...]
+		  $ cat /sys/kernel/debug/iommu/amd/iommu<x>/cmdbuf
+
+		Output::
+
+		  CMD Buffer Head Offset:339 Tail Offset:339
+		    0: 00835001 10000001 00003c00 00000000
+		    1: 00000000 30000005 fffff003 7fffffff
+		    2: 00835001 10000001 00003c01 00000000
+		    3: 00000000 30000005 fffff003 7fffffff
+		    4: 00835001 10000001 00003c02 00000000
+		    5: 00000000 30000005 fffff003 7fffffff
+		    6: 00835001 10000001 00003c03 00000000
+		    7: 00000000 30000005 fffff003 7fffffff
+		    8: 00835001 10000001 00003c04 00000000
+		    9: 00000000 30000005 fffff003 7fffffff
+		   10: 00835001 10000001 00003c05 00000000
+		   11: 00000000 30000005 fffff003 7fffffff
+		  [...]
 
 What:		/sys/kernel/debug/iommu/amd/devid
 Date:		January 2025
@@ -63,19 +69,26 @@ Description:
 		interrupt remapping table and device table.
 
 		Example:
-		1.
-		$ echo 0000:01:00.0 > /sys/kernel/debug/iommu/amd/devid
-		$ cat /sys/kernel/debug/iommu/amd/devid
 
-		Output:
-		0000:01:00.0
+		1.
+		  ::
+
+		    $ echo 0000:01:00.0 > /sys/kernel/debug/iommu/amd/devid
+		    $ cat /sys/kernel/debug/iommu/amd/devid
+
+		  Output::
+
+		    0000:01:00.0
 
 		2.
-		$ echo 01:00.0 > /sys/kernel/debug/iommu/amd/devid
-		$ cat /sys/kernel/debug/iommu/amd/devid
+		  ::
 
-		Output:
-		0000:01:00.0
+		    $ echo 01:00.0 > /sys/kernel/debug/iommu/amd/devid
+		    $ cat /sys/kernel/debug/iommu/amd/devid
+
+		  Output::
+
+		    0000:01:00.0
 
 What:		/sys/kernel/debug/iommu/amd/devtbl
 Date:		January 2025
@@ -84,12 +97,14 @@ Description:
 		This file is a read-only output file containing the device table entry
 		for the device ID provided in /sys/kernel/debug/iommu/amd/devid.
 
-		Example:
-		$ cat /sys/kernel/debug/iommu/amd/devtbl
+		Example::
 
-		Output:
-		DeviceId             QWORD[3]         QWORD[2]         QWORD[1]         QWORD[0] iommu
-		0000:01:00.0 0000000000000000 20000001373b8013 0000000000000038 6000000114d7b603 iommu3
+		  $ cat /sys/kernel/debug/iommu/amd/devtbl
+
+		Output::
+
+		  DeviceId             QWORD[3]         QWORD[2]         QWORD[1]         QWORD[0] iommu
+		  0000:01:00.0 0000000000000000 20000001373b8013 0000000000000038 6000000114d7b603 iommu3
 
 What:		/sys/kernel/debug/iommu/amd/irqtbl
 Date:		January 2025
@@ -98,17 +113,19 @@ Description:
 		This file is a read-only output file containing valid IRT table entries
 		for the device ID provided in /sys/kernel/debug/iommu/amd/devid.
 
-		Example:
-		$ cat /sys/kernel/debug/iommu/amd/irqtbl
+		Example::
 
-		Output:
-		DeviceId 0000:01:00.0
-		IRT[0000] 0000000000000020 0000000000000241
-		IRT[0001] 0000000000000020 0000000000000841
-		IRT[0002] 0000000000000020 0000000000002041
-		IRT[0003] 0000000000000020 0000000000008041
-		IRT[0004] 0000000000000020 0000000000020041
-		IRT[0005] 0000000000000020 0000000000080041
-		IRT[0006] 0000000000000020 0000000000200041
-		IRT[0007] 0000000000000020 0000000000800041
-		[...]
+		  $ cat /sys/kernel/debug/iommu/amd/irqtbl
+
+		Output::
+
+		  DeviceId 0000:01:00.0
+		  IRT[0000] 0000000000000020 0000000000000241
+		  IRT[0001] 0000000000000020 0000000000000841
+		  IRT[0002] 0000000000000020 0000000000002041
+		  IRT[0003] 0000000000000020 0000000000008041
+		  IRT[0004] 0000000000000020 0000000000020041
+		  IRT[0005] 0000000000000020 0000000000080041
+		  IRT[0006] 0000000000000020 0000000000200041
+		  IRT[0007] 0000000000000020 0000000000800041
+		  [...]

base-commit: 4ba382d42e2dd8294311fd4ee1ad446c8e5585aa
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
Posted by Will Deacon 2 months, 3 weeks ago 
On Thu, 17 Jul 2025 08:03:31 +0700, Bagas Sanjaya wrote:
> Commit 39215bb3b0d929 ("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]
> 
> [...]

Applied to iommu (amd/amd-vi), thanks!

[1/1] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
      https://git.kernel.org/iommu/c/9628e5c85b1e

Cheers,
-- 
Will

https://fixes.arm64.dev
https://next.arm64.dev
https://will.arm64.dev
Re: [PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
Posted by Randy Dunlap 2 months, 3 weeks ago 

On 7/16/25 6:03 PM, Bagas Sanjaya wrote:
> Commit 39215bb3b0d929 ("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: 39215bb3b0d9 ("iommu/amd: Add documentation for AMD IOMMU debugfs support")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250716204207.73869849@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/ABI/testing/debugfs-amd-iommu | 125 +++++++++++---------
>  1 file changed, 71 insertions(+), 54 deletions(-)

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

-- 
~Randy

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.