* [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions
@ 2014-11-18 17:07 Euan Harris
2014-11-18 17:44 ` Ian Jackson
0 siblings, 1 reply; 4+ messages in thread
From: Euan Harris @ 2014-11-18 17:07 UTC (permalink / raw)
To: xen-devel; +Cc: Euan Harris, ian.jackson
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.
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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions
2014-11-18 17:07 [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions Euan Harris
@ 2014-11-18 17:44 ` Ian Jackson
2014-11-18 18:19 ` Konrad Rzeszutek Wilk
0 siblings, 1 reply; 4+ messages in thread
From: Ian Jackson @ 2014-11-18 17:44 UTC (permalink / raw)
To: Euan Harris, Konrad Wilk; +Cc: Wei Liu, Ian Campbell, xen-devel
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.
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
>
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions
2014-11-18 17:44 ` Ian Jackson
@ 2014-11-18 18:19 ` Konrad Rzeszutek Wilk
2014-11-20 15:57 ` Ian Campbell
0 siblings, 1 reply; 4+ messages in thread
From: Konrad Rzeszutek Wilk @ 2014-11-18 18:19 UTC (permalink / raw)
To: Ian Jackson; +Cc: Wei Liu, Euan Harris, Ian Campbell, xen-devel
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
> >
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions
2014-11-18 18:19 ` Konrad Rzeszutek Wilk
@ 2014-11-20 15:57 ` Ian Campbell
0 siblings, 0 replies; 4+ messages in thread
From: Ian Campbell @ 2014-11-20 15:57 UTC (permalink / raw)
To: Konrad Rzeszutek Wilk; +Cc: Euan Harris, Wei Liu, Ian Jackson, xen-devel
On Tue, 2014-11-18 at 13:19 -0500, Konrad Rzeszutek Wilk wrote:
> 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>
and applied, thanks all.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2014-11-20 15:57 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-11-18 17:07 [PATCH] libxl: Document device parameter of libxl_device_<type>_add functions Euan Harris
2014-11-18 17:44 ` Ian Jackson
2014-11-18 18:19 ` Konrad Rzeszutek Wilk
2014-11-20 15:57 ` Ian Campbell
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.