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

[Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>]

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@xxxxxxxxxxxxx>

Konrad, this should go into 4.5 IMO because it's a doc comment
describing existing behaviour which we want everyone to rely on.

Ian.

> Signed-off-by: Euan Harris <euan.harris@xxxxxxxxxx>
> ---
>  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
> 

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel