linux-kernel - Re: [PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu

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: <e93153a1-4abf-46e3-a652-e95fe494b315@infradead.org>
Date: Thu, 6 Nov 2025 15:49:08 -0800
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: Jonathan Corbet <corbet@....net>, Joerg Roedel <joro@...tes.org>,
 Will Deacon <will@...nel.org>, Robin Murphy <robin.murphy@....com>,
 Jason Gunthorpe <jgg@...pe.ca>, Samiullah Khawaja <skhawaja@...gle.com>,
 Kevin Tian <kevin.tian@...el.com>, Lu Baolu <baolu.lu@...ux.intel.com>,
 Pasha Tatashin <pasha.tatashin@...een.com>,
 Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH 1/2] Documentation: genpt: Don't use code block marker
 before iommu_amdv1.c include listing



On 11/5/25 11:38 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warning when merging iommu tree:
> 
> Documentation/driver-api/generic_pt.rst:32: WARNING: Literal block expected; none found. [docutils]
> 
> This is because of duplicate double colon code block markers: one after
> generic_pt/fmt/iommu_amdv1.c and the one in its preceding paragraph. The
> resulting htmldocs, however, only marks the include listing (after the
> former) up as it should be.
> 
> Drop the latter to fix the warning.
> 
> Fixes: ab0b572847ac ("genpt: Add Documentation/ files")
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251106143925.578e411b@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/driver-api/generic_pt.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/generic_pt.rst b/Documentation/driver-api/generic_pt.rst
> index 210d1229aa1c1f..7a9ca9f2878d4f 100644
> --- a/Documentation/driver-api/generic_pt.rst
> +++ b/Documentation/driver-api/generic_pt.rst
> @@ -27,7 +27,7 @@ compiled into a per-format IOMMU operations kernel module.
>  For this to work the .c file for each compilation unit will include both the
>  format headers and the generic code for the implementation. For instance in an
>  implementation compilation unit the headers would normally be included as
> -follows::
> +follows:
>  
>  generic_pt/fmt/iommu_amdv1.c::
>  


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

-- 
~Randy