mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux IOMMU <iommu@lists.linux.dev>
Cc: Jonathan Corbet <corbet@lwn.net>, Joerg Roedel <joro@8bytes.org>,
	Will Deacon <will@kernel.org>,
	Robin Murphy <robin.murphy@arm.com>,
	Jason Gunthorpe <jgg@ziepe.ca>,
	Samiullah Khawaja <skhawaja@google.com>,
	Kevin Tian <kevin.tian@intel.com>,
	Lu Baolu <baolu.lu@linux.intel.com>,
	Pasha Tatashin <pasha.tatashin@soleen.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu_amdv1.c include listing
Date: Thu, 6 Nov 2025 15:49:08 -0800	[thread overview]
Message-ID: <e93153a1-4abf-46e3-a652-e95fe494b315@infradead.org> (raw)
In-Reply-To: <20251106073845.36445-2-bagasdotme@gmail.com>



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

  reply	other threads:[~2025-11-06 23:49 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-06  7:38 [PATCH 0/2] genpt documentation fixes Bagas Sanjaya
2025-11-06  7:38 ` [PATCH 1/2] Documentation: genpt: Don't use code block marker before iommu_amdv1.c include listing Bagas Sanjaya
2025-11-06 23:49   ` Randy Dunlap [this message]
2025-11-06  7:38 ` [PATCH 2/2] iommupt: Describe @bitnr parameter Bagas Sanjaya
2025-11-06 23:48   ` Randy Dunlap
2025-11-07  0:35     ` Jason Gunthorpe
2025-11-07  5:14       ` Bagas Sanjaya
2025-11-06 13:12 ` [PATCH 0/2] genpt documentation fixes Jason Gunthorpe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e93153a1-4abf-46e3-a652-e95fe494b315@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=bagasdotme@gmail.com \
    --cc=baolu.lu@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=iommu@lists.linux.dev \
    --cc=jgg@ziepe.ca \
    --cc=joro@8bytes.org \
    --cc=kevin.tian@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pasha.tatashin@soleen.com \
    --cc=robin.murphy@arm.com \
    --cc=sfr@canb.auug.org.au \
    --cc=skhawaja@google.com \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®