This is exactly what .rst files can provide.+/*
+ * 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
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