[PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu_amdv1.c include listing

Bagas Sanjaya posted 2 patches 3 months ago
There is a newer version of this series
[PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu_amdv1.c include listing
Posted by Bagas Sanjaya 3 months ago
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@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251106143925.578e411b@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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::
 
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu_amdv1.c include listing
Posted by Randy Dunlap 3 months ago

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@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251106143925.578e411b@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy