From: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
To: Elliot Berman <quic_eberman@quicinc.com>,
Alex Elder <elder@linaro.org>,
Prakruthi Deepak Heragu <quic_pheragu@quicinc.com>
Cc: Murali Nalajala <quic_mnalajal@quicinc.com>,
Trilok Soni <quic_tsoni@quicinc.com>,
Srivatsa Vaddagiri <quic_svaddagi@quicinc.com>,
Carl van Schaik <quic_cvanscha@quicinc.com>,
Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
Bjorn Andersson <andersson@kernel.org>,
Konrad Dybcio <konrad.dybcio@linaro.org>,
Arnd Bergmann <arnd@arndb.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Jonathan Corbet <corbet@lwn.net>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Catalin Marinas <catalin.marinas@arm.com>,
Jassi Brar <jassisinghbrar@gmail.com>,
linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH v10 12/26] gunyah: vm_mgr: Add/remove user memory regions
Date: Fri, 24 Feb 2023 10:36:54 +0000 [thread overview]
Message-ID: <82a6780a-71d5-746a-aa69-c2bc32755979@linaro.org> (raw)
In-Reply-To: <8f47b97a-9341-110e-c96b-7efdb395d110@quicinc.com>
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
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2023-02-24 10:37 UTC|newest]
Thread overview: 111+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-14 21:12 [PATCH v10 00/26] Drivers for Gunyah hypervisor Elliot Berman
2023-02-14 21:12 ` [PATCH v10 01/26] docs: gunyah: Introduce Gunyah Hypervisor Elliot Berman
2023-02-23 23:41 ` Alex Elder
2023-03-01 0:00 ` Elliot Berman
2023-02-14 21:12 ` [PATCH v10 02/26] dt-bindings: Add binding for gunyah hypervisor Elliot Berman
2023-02-14 21:12 ` [PATCH v10 03/26] gunyah: Common types and error codes for Gunyah hypercalls Elliot Berman
2023-02-23 21:58 ` Alex Elder
2023-03-02 1:40 ` Elliot Berman
2023-03-02 7:18 ` Arnd Bergmann
2023-02-14 21:12 ` [PATCH v10 04/26] virt: gunyah: Add hypercalls to identify Gunyah Elliot Berman
2023-02-20 13:59 ` Srinivas Kandagatla
2023-02-24 0:09 ` Alex Elder
2023-03-02 1:21 ` Elliot Berman
2023-02-14 21:18 ` Elliot Berman
2023-02-14 21:21 ` [PATCH v10 05/26] virt: gunyah: Identify hypervisor version Elliot Berman
2023-02-14 21:23 ` [PATCH v10 06/26] virt: gunyah: msgq: Add hypercalls to send and receive messages Elliot Berman
2023-02-24 0:15 ` Alex Elder
2023-02-24 21:24 ` Elliot Berman
2023-02-14 21:23 ` [PATCH v10 07/26] mailbox: Add Gunyah message queue mailbox Elliot Berman
2023-02-16 4:07 ` kernel test robot
2023-02-20 13:59 ` Srinivas Kandagatla
2023-02-23 0:15 ` Elliot Berman
2023-02-23 10:25 ` Srinivas Kandagatla
2023-02-23 23:15 ` Elliot Berman
2023-02-24 7:49 ` Srinivas Kandagatla
2023-02-23 18:24 ` Alex Elder
2023-02-23 21:11 ` Alex Elder
2023-02-24 21:57 ` Elliot Berman
2023-02-14 21:23 ` [PATCH v10 08/26] gunyah: rsc_mgr: Add resource manager RPC core Elliot Berman
2023-02-16 6:43 ` Greg Kroah-Hartman
2023-02-16 17:40 ` Elliot Berman
2023-02-17 7:37 ` Greg Kroah-Hartman
2023-02-22 22:52 ` Elliot Berman
2023-02-20 18:10 ` Srinivas Kandagatla
2023-02-22 23:18 ` Elliot Berman
2023-02-23 10:29 ` Srinivas Kandagatla
2023-02-23 23:13 ` Elliot Berman
2023-02-28 0:52 ` Alex Elder
2023-02-28 22:49 ` Elliot Berman
2023-02-23 23:28 ` Alex Elder
2023-02-24 22:39 ` Elliot Berman
2023-02-14 21:23 ` [PATCH v10 09/26] gunyah: rsc_mgr: Add VM lifecycle RPC Elliot Berman
2023-02-16 6:39 ` Greg Kroah-Hartman
2023-02-16 17:18 ` Elliot Berman
2023-02-21 7:50 ` Srinivas Kandagatla
2023-02-23 21:36 ` Alex Elder
2023-02-23 23:10 ` Elliot Berman
2023-02-14 21:23 ` [PATCH v10 10/26] gunyah: vm_mgr: Introduce basic VM Manager Elliot Berman
2023-02-21 10:46 ` Srinivas Kandagatla
2023-02-22 0:27 ` Elliot Berman
2023-02-23 10:08 ` Srinivas Kandagatla
2023-02-23 22:40 ` Elliot Berman
2023-02-24 10:29 ` Srinivas Kandagatla
2023-02-24 13:20 ` Arnd Bergmann
2023-02-24 22:48 ` Elliot Berman
2023-02-28 1:06 ` Alex Elder
2023-02-28 9:19 ` Arnd Bergmann
2023-02-21 13:06 ` Srivatsa Vaddagiri
2023-02-14 21:24 ` [PATCH v10 11/26] gunyah: rsc_mgr: Add RPC for sharing memory Elliot Berman
2023-02-21 11:07 ` Srinivas Kandagatla
2023-02-14 21:24 ` [PATCH v10 12/26] gunyah: vm_mgr: Add/remove user memory regions Elliot Berman
2023-02-16 6:38 ` Greg Kroah-Hartman
2023-02-16 17:24 ` Elliot Berman
2023-02-21 12:28 ` Srinivas Kandagatla
2023-02-21 12:43 ` Srivatsa Vaddagiri
2023-02-24 0:43 ` Elliot Berman
2023-02-24 10:36 ` Srinivas Kandagatla [this message]
2023-02-21 12:45 ` Srivatsa Vaddagiri
2023-02-24 0:34 ` Alex Elder
2023-02-25 1:03 ` Elliot Berman
2023-02-24 10:19 ` Fuad Tabba
2023-02-24 18:08 ` Elliot Berman
2023-02-24 18:58 ` Sean Christopherson
2023-02-27 9:55 ` Fuad Tabba
2023-02-14 21:24 ` [PATCH v10 13/26] gunyah: vm_mgr: Add ioctls to support basic non-proxy VM boot Elliot Berman
2023-02-16 6:35 ` Greg Kroah-Hartman
2023-02-16 17:20 ` Elliot Berman
2023-02-20 9:15 ` Srivatsa Vaddagiri
2023-02-20 9:54 ` Srivatsa Vaddagiri
2023-02-21 13:06 ` Srivatsa Vaddagiri
2023-02-21 14:17 ` Srinivas Kandagatla
2023-02-23 0:50 ` Elliot Berman
2023-02-23 9:21 ` Srinivas Kandagatla
2023-02-14 21:24 ` [PATCH v10 14/26] samples: Add sample userspace Gunyah VM Manager Elliot Berman
2023-02-14 21:24 ` [PATCH v10 15/26] gunyah: rsc_mgr: Add platform ops on mem_lend/mem_reclaim Elliot Berman
2023-02-21 14:51 ` Srinivas Kandagatla
2023-02-21 21:22 ` Elliot Berman
2023-02-22 10:21 ` Srinivas Kandagatla
2023-02-23 1:55 ` Elliot Berman
2023-02-14 21:24 ` [PATCH v10 16/26] firmware: qcom_scm: Register Gunyah platform ops Elliot Berman
2023-02-16 0:22 ` kernel test robot
2023-02-16 11:09 ` kernel test robot
2023-02-21 14:55 ` Srinivas Kandagatla
2023-02-14 21:25 ` [PATCH v10 17/26] docs: gunyah: Document Gunyah VM Manager Elliot Berman
2023-02-23 23:55 ` Alex Elder
2023-02-14 21:25 ` [PATCH v10 18/26] virt: gunyah: Translate gh_rm_hyp_resource into gunyah_resource Elliot Berman
2023-02-21 17:47 ` Srinivas Kandagatla
2023-02-14 21:25 ` [PATCH v10 19/26] gunyah: vm_mgr: Add framework to add VM Functions Elliot Berman
2023-02-17 13:23 ` Srivatsa Vaddagiri
2023-02-21 13:07 ` Srivatsa Vaddagiri
2023-02-21 17:58 ` Srinivas Kandagatla
2023-02-22 14:08 ` Srinivas Kandagatla
2023-02-24 23:44 ` Elliot Berman
2023-02-14 21:25 ` [PATCH v10 20/26] virt: gunyah: Add resource tickets Elliot Berman
2023-02-14 21:25 ` [PATCH v10 21/26] virt: gunyah: Add IO handlers Elliot Berman
2023-02-14 21:26 ` [PATCH v10 22/26] virt: gunyah: Add proxy-scheduled vCPUs Elliot Berman
2023-02-14 21:26 ` [PATCH v10 23/26] virt: gunyah: Add hypercalls for sending doorbell Elliot Berman
2023-02-14 21:26 ` [PATCH v10 24/26] virt: gunyah: Add irqfd interface Elliot Berman
2023-02-14 21:26 ` [PATCH v10 25/26] virt: gunyah: Add ioeventfd Elliot Berman
2023-02-14 21:26 ` [PATCH v10 26/26] MAINTAINERS: Add Gunyah hypervisor drivers section Elliot Berman
2023-02-23 21:59 ` [PATCH v10 00/26] Drivers for Gunyah hypervisor Alex Elder
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=82a6780a-71d5-746a-aa69-c2bc32755979@linaro.org \
--to=srinivas.kandagatla@linaro.org \
--cc=andersson@kernel.org \
--cc=arnd@arndb.de \
--cc=bagasdotme@gmail.com \
--cc=catalin.marinas@arm.com \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.baryshkov@linaro.org \
--cc=elder@linaro.org \
--cc=gregkh@linuxfoundation.org \
--cc=jassisinghbrar@gmail.com \
--cc=konrad.dybcio@linaro.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=quic_cvanscha@quicinc.com \
--cc=quic_eberman@quicinc.com \
--cc=quic_mnalajal@quicinc.com \
--cc=quic_pheragu@quicinc.com \
--cc=quic_svaddagi@quicinc.com \
--cc=quic_tsoni@quicinc.com \
--cc=robh+dt@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).