linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: fix spelling errors in iommufd.rst
@ 2025-08-15 15:37 Alessandro Ratti
  2025-08-15 15:37 ` Alessandro Ratti
  0 siblings, 1 reply; 3+ messages in thread
From: Alessandro Ratti @ 2025-08-15 15:37 UTC (permalink / raw)
  To: jgg, kevin.tian, corbet; +Cc: skhan, iommu, linux-doc, alessandro.ratti


Hi,

While working on a task for the Linux Kernel Mentorship Program, I scanned the
kernel documentation using `codespell` to identify any outstanding spelling
mistakes.

During the process, I discovered two typos in `Documentation/userspace-api/iommufd.rst`:

  - "primarly" → "primarily"
  - "sharable" → "shareable"

This patch corrects these minor errors. I’ve excluded already translated and
autogenerated files from the scan to avoid false positives. The command used
was:

  codespell Documentation \
    -S "Documentation/translations/*,**/_build/*,**/*.po,**/*.pot,**/*.pdf,**/*.svg" \
    -L "te,fo,uefi,sysfs,procfs,virtio,irq,skb,uname,userspace,nd"

Patch applies cleanly on top of mainline.

Thanks for your time and consideration.

Best regards,  
Alessandro

^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH] Documentation: fix spelling errors in iommufd.rst
  2025-08-15 15:37 [PATCH] Documentation: fix spelling errors in iommufd.rst Alessandro Ratti
@ 2025-08-15 15:37 ` Alessandro Ratti
  2025-08-18 14:15   ` Jason Gunthorpe
  0 siblings, 1 reply; 3+ messages in thread
From: Alessandro Ratti @ 2025-08-15 15:37 UTC (permalink / raw)
  To: jgg, kevin.tian, corbet
  Cc: skhan, iommu, linux-doc, alessandro.ratti, Alessandro Ratti

This patch corrects two minor spelling issues found in
Documentation/userspace-api/iommufd.rst:

- "primarly" -> "primarily"
- "sharable" -> "shareable"

Found using codespell(1).

Signed-off-by: Alessandro Ratti <alessandro@0x65c.net>
---
 Documentation/userspace-api/iommufd.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/userspace-api/iommufd.rst b/Documentation/userspace-api/iommufd.rst
index 03f7510384d2..f1c4d21e5c5e 100644
--- a/Documentation/userspace-api/iommufd.rst
+++ b/Documentation/userspace-api/iommufd.rst
@@ -43,7 +43,7 @@ Following IOMMUFD objects are exposed to userspace:
 
 - IOMMUFD_OBJ_HWPT_PAGING, representing an actual hardware I/O page table
   (i.e. a single struct iommu_domain) managed by the iommu driver. "PAGING"
-  primarly indicates this type of HWPT should be linked to an IOAS. It also
+  primarily indicates this type of HWPT should be linked to an IOAS. It also
   indicates that it is backed by an iommu_domain with __IOMMU_DOMAIN_PAGING
   feature flag. This can be either an UNMANAGED stage-1 domain for a device
   running in the user space, or a nesting parent stage-2 domain for mappings
@@ -76,7 +76,7 @@ Following IOMMUFD objects are exposed to userspace:
 
   * Security namespace for guest owned ID, e.g. guest-controlled cache tags
   * Non-device-affiliated event reporting, e.g. invalidation queue errors
-  * Access to a sharable nesting parent pagetable across physical IOMMUs
+  * Access to a shareable nesting parent pagetable across physical IOMMUs
   * Virtualization of various platforms IDs, e.g. RIDs and others
   * Delivery of paravirtualized invalidation
   * Direct assigned invalidation queues
-- 
2.39.5


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] Documentation: fix spelling errors in iommufd.rst
  2025-08-15 15:37 ` Alessandro Ratti
@ 2025-08-18 14:15   ` Jason Gunthorpe
  0 siblings, 0 replies; 3+ messages in thread
From: Jason Gunthorpe @ 2025-08-18 14:15 UTC (permalink / raw)
  To: Alessandro Ratti
  Cc: kevin.tian, corbet, skhan, iommu, linux-doc, alessandro.ratti

On Fri, Aug 15, 2025 at 05:37:26PM +0200, Alessandro Ratti wrote:
> This patch corrects two minor spelling issues found in
> Documentation/userspace-api/iommufd.rst:
> 
> - "primarly" -> "primarily"
> - "sharable" -> "shareable"
> 
> Found using codespell(1).
> 
> Signed-off-by: Alessandro Ratti <alessandro@0x65c.net>
> ---
>  Documentation/userspace-api/iommufd.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

I'll pick this up to for-rc, thanks

Jason

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-08-18 14:15 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-15 15:37 [PATCH] Documentation: fix spelling errors in iommufd.rst Alessandro Ratti
2025-08-15 15:37 ` Alessandro Ratti
2025-08-18 14:15   ` Jason Gunthorpe

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).