On Thu, Nov 07, 2024 at 07:56:31AM +0700, Bagas Sanjaya wrote:
> On Tue, Nov 05, 2024 at 12:04:29PM -0800, Nicolin Chen wrote:
> > With the introduction of the new object and its infrastructure, update the
> > doc to reflect that and add a new graph.
> > 
> > Reviewed-by: Jason Gunthorpe <[email protected]>
> > Reviewed-by: Kevin Tian <[email protected]>
> > Signed-off-by: Nicolin Chen <[email protected]>
> > ---
> >  Documentation/userspace-api/iommufd.rst | 69 ++++++++++++++++++++++++-
> >  1 file changed, 68 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/userspace-api/iommufd.rst 
> > b/Documentation/userspace-api/iommufd.rst
> > index 2deba93bf159..a8b7766c2849 100644
> > --- a/Documentation/userspace-api/iommufd.rst
> > +++ b/Documentation/userspace-api/iommufd.rst
> > @@ -63,6 +63,37 @@ Following IOMMUFD objects are exposed to userspace:
> >    space usually has mappings from guest-level I/O virtual addresses to 
> > guest-
> >    level physical addresses.
> >  
> > +- IOMMUFD_OBJ_VIOMMU, representing a slice of the physical IOMMU instance,
> > +  passed to or shared with a VM. It may be some HW-accelerated 
> > virtualization
> > +  features and some SW resources used by the VM. For examples:
> > +  * 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
> > +  * Virtualization of various platforms IDs, e.g. RIDs and others
> > +  * Delivery of paravirtualized invalidation
> > +  * Direct assigned invalidation queues
> > +  * Direct assigned interrupts
> 
> The bullet list above is outputted in htmldocs build as long-running paragraph
> instead.

Oh, I overlooked this list.

Would the following change be okay?

-------------------------------------------------
diff --git a/Documentation/userspace-api/iommufd.rst 
b/Documentation/userspace-api/iommufd.rst
index 0ef22b3ca30b..011cbc71b6f5 100644
--- a/Documentation/userspace-api/iommufd.rst
+++ b/Documentation/userspace-api/iommufd.rst
@@ -68,2 +68,3 @@ Following IOMMUFD objects are exposed to userspace:
   features and some SW resources used by the VM. For examples:
+
   * Security namespace for guest owned ID, e.g. guest-controlled cache tags
@@ -75,2 +76,3 @@ Following IOMMUFD objects are exposed to userspace:
   * Direct assigned interrupts
+
   Such a vIOMMU object generally has the access to a nesting parent pagetable
-------------------------------------------------

The outputted html is showing a list with this.

Thanks!
Nicolin

Reply via email to