Re: [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions

[Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>]

On Tue, Nov 18, 2014 at 05:44:20PM +0000, Ian Jackson wrote:
> Euan Harris writes ("[PATCH] libxl: Document device parameter of libxl_device_<type>_add functions"):
> > The device parameter of libxl_device_<type>_add is an in/out parameter.
> > Unspecified fields are filled in with appropriate values for the created
> > device when the function returns.  Document this behaviour.
> 
> Thanks.
> 
> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
> 
> Konrad, this should go into 4.5 IMO because it's a doc comment
> describing existing behaviour which we want everyone to rely on.

Release-Acked-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> 
> Ian.
> 
> > Signed-off-by: Euan Harris <euan.harris@citrix.com>
> > ---
> >  tools/libxl/libxl.h | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
> > index c3451bd..41d6e8d 100644
> > --- a/tools/libxl/libxl.h
> > +++ b/tools/libxl/libxl.h
> > @@ -1109,6 +1109,10 @@ void libxl_vtpminfo_list_free(libxl_vtpminfo *, int nr_vtpms);
> >   *   domain to connect to the device and therefore cannot block on the
> >   *   guest.
> >   *
> > + *   device is an in/out parameter:  fields left unspecified when the
> > + *   structure is passed in are filled in with appropriate values for
> > + *   the device created.
> > + *
> >   * libxl_device_<type>_remove(ctx, domid, device):
> >   *
> >   *   Removes the given device from the specified domain by performing
> > -- 
> > 1.9.3
> >