Re: [PATCH v10 12/26] gunyah: vm_mgr: Add/remove user memory regions

[Srinivas Kandagatla]

On 24/02/2023 00:43, Elliot Berman wrote:
> > > +/*
> > > + * ioctls for VM fds
> > > + */
> > > +
> > > +/**
> > > + * struct gh_userspace_memory_region - Userspace memory descripion 
> > > for GH_VM_SET_USER_MEM_REGION
> > > + * @label: Unique identifer to the region.
> > > + * @flags: Flags for memory parcel behavior
> > > + * @guest_phys_addr: Location of the memory region in guest's memory 
> > > space (page-aligned)#
> >
> > Note about overlapping here would be useful.
>
> I'd like to reduce duplicate documentation where possible. I was 
This is exactly what .rst files can provide.

If you have a proper kernel-doc type documentation in header/source 
files, these can be directly used in .rst files.

The reStructuredText (.rst) files may contain directives to include 
structured documentation comments, or kernel-doc comments, from source 
files.

ex:
.. kernel-doc:: include/linux/gunyah.h
   :internal:


--srini
> generally following this procedure:
>   - include/uapi/linux/gunyah.h docstrings have basic information to 
> remind what the field is
>   - Documentation/virt/gunyah/ documentation explains how to properly 
> use the APIs
>
> I think it's definitely good idea to have separate documentation beyond 
> what can be described in docstrings here.
>
> Thanks,
> Elliot