Re: [RFC PATCH v1] xen/docs: Document acquire resource interface

[Matias Vara <matiasevara@xxxxxxxxx>]

On Tue, Aug 30, 2022 at 01:06:11PM +0100, Paul Durrant wrote:
> On 29/08/2022 10:03, Matias Ezequiel Vara Larsen wrote:
> > This commit creates a new doc to document the acquire resource interface. 
> > This
> > is a reference document.
> >
> > Signed-off-by: Matias Ezequiel Vara Larsen <matias.vara@xxxxxxxx>
> > ---
> > Changes in v1:
> > - correct documentation about how mfns are allocated
> > - correct documentation about how mfns are released
> > - use the wording tool instead of pv tool
> > - fix typos
> > ---
> >   .../acquire_resource_reference.rst            | 338 ++++++++++++++++++
> >   docs/hypervisor-guide/index.rst               |   2 +
> >   2 files changed, 340 insertions(+)
> >   create mode 100644 docs/hypervisor-guide/acquire_resource_reference.rst
> >
> > diff --git a/docs/hypervisor-guide/acquire_resource_reference.rst 
> > b/docs/hypervisor-guide/acquire_resource_reference.rst
> > new file mode 100644
> > index 0000000000..d1989d2fd4
> > --- /dev/null
> > +++ b/docs/hypervisor-guide/acquire_resource_reference.rst
> > @@ -0,0 +1,338 @@
> > +.. SPDX-License-Identifier: CC-BY-4.0
> > +
> > +Acquire resource reference
> > +==========================
> > +
> > +Acquire resource allows you to share a resource between Xen and dom0.
>
> That doesn't sound right. The resources 'belong' to Xen, and are specific to
> a particular domain (A). Another domain (B) with enough privilege over
> domain A can then map and hence access those resources.
>
>   Paul

Thanks Paul, It would sound better something like:

"The acquire resource interface enables sharing resources that are specific to
a particular domain and belongs to Xen with a domain with enough privileges,
e.g., dom0. This domain can map and hence access those resources.”

Matias

>
>