Re: [Xen-devel] [PATCH v2 3/4] xen/public: Document HYPERCALL_console_io()

[Julien Grall <julien.grall@xxxxxxx>]

On 8/16/19 6:42 PM, Julien Grall wrote:
> Hi,
>
> On 08/08/2019 15:03, Jan Beulich wrote:
> > On 05.08.2019 15:29, Julien Grall wrote:
> > > Currently, OS developpers will have to look at Xen code in order to know
> > > the parameters of an hypercall and how it is meant to work.
> > >
> > > This is not a trivial task as you may need to have a deep understanding
> > > of Xen internal.
> > >
> > > This patch attempts to document the behavior of 
> > > HYPERCALL_console_io() to
> > > help OS developer.
> > >
> > > Signed-off-by: Julien Grall <julien.grall@xxxxxxx>
> > Acked-by: Jan Beulich <jbeulich@xxxxxxxx>
> > with a couple of nits:
> >
> > > --- a/xen/include/public/xen.h
> > > +++ b/xen/include/public/xen.h
> > > @@ -486,7 +486,29 @@ DEFINE_XEN_GUEST_HANDLE(mmuext_op_t);
> > >    /* ` } */
> > >    /*
> > > - * Commands to HYPERVISOR_console_io().
> > > + * ` int
> > > + * ` HYPERVISOR_console_io(unsigned int cmd,
> > > + * `                       unsigned int count,
> > > + * `                       char buffer[]);
> > > + *
> > > + * @cmd: Command (see below)
> > > + * @count: Size of the buffer to read/write
> > > + * @buffer: Pointer in the guest memory
> > > + *
> > > + * List of commands:
> > > + *
> > > + *  * CONSOLEIO_write: Write the buffer on Xen console.
> > s/ on / to / ?
> I am not entirely sure. Looking online [1] "on" would make sense here.
>
> But I am not a native english speaker. @George, @Ian, @Andrew, any 
> opinions?
Speaking with my partner today (who is native english), "to" is actually 
the correct version here. So I will use "to" here.
Cheers,

--
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel