linux-kernel.vger.kernel.org archive mirror
 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: "Dheeraj Kumar Srivastava" <dheerajkumar.srivastava@amd.com>,
	"Will Deacon" <will@kernel.org>,
	"Vasant Hegde" <vasant.hegde@amd.com>,
	"Ashish Kalra" <Ashish.Kalra@amd.com>,
	"Jörg Rödel" <joro@8bytes.org>,
	"Suravee Suthikulpanit" <suravee.suthikulpanit@amd.com>,
	"Robin Murphy" <robin.murphy@arm.com>,
	"Stephen Rothwell" <sfr@canb.auug.org.au>
Subject: Re: [PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks
Date: Wed, 16 Jul 2025 19:10:52 -0700	[thread overview]
Message-ID: <c8fdeee9-6421-4943-9c79-f3a48441488a@infradead.org> (raw)
In-Reply-To: <20250717010331.8941-1-bagasdotme@gmail.com>



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

  reply	other threads:[~2025-07-17  2:10 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-17  1:03 [PATCH] iommu/amd: Wrap debugfs ABI testing symbols snippets in literal code blocks Bagas Sanjaya
2025-07-17  2:10 ` Randy Dunlap [this message]
2025-07-17 10:01 ` Will Deacon

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=c8fdeee9-6421-4943-9c79-f3a48441488a@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=Ashish.Kalra@amd.com \
    --cc=bagasdotme@gmail.com \
    --cc=dheerajkumar.srivastava@amd.com \
    --cc=iommu@lists.linux.dev \
    --cc=joro@8bytes.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robin.murphy@arm.com \
    --cc=sfr@canb.auug.org.au \
    --cc=suravee.suthikulpanit@amd.com \
    --cc=vasant.hegde@amd.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;
as well as URLs for NNTP newsgroup(s).