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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <c8fdeee9-6421-4943-9c79-f3a48441488a@infradead.org>
Date: Wed, 16 Jul 2025 19:10:52 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Documentation <linux-doc@...r.kernel.org>,
 Linux IOMMU <iommu@...ts.linux.dev>
Cc: Dheeraj Kumar Srivastava <dheerajkumar.srivastava@....com>,
 Will Deacon <will@...nel.org>, Vasant Hegde <vasant.hegde@....com>,
 Ashish Kalra <Ashish.Kalra@....com>, Jörg Rödel
 <joro@...tes.org>, Suravee Suthikulpanit <suravee.suthikulpanit@....com>,
 Robin Murphy <robin.murphy@....com>, Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in
 literal code blocks



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@...b.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250716204207.73869849@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/ABI/testing/debugfs-amd-iommu | 125 +++++++++++---------
>  1 file changed, 71 insertions(+), 54 deletions(-)

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

Thanks.

-- 
~Randy