libxl: Document device parameter of libxl_device_<type>_add functions
PATCH 1/1 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.
--- tools/libxl/libxl.h | 4 ++++ 1 file changed, 4 insertions(+)
tools/libxl/libxl.h +4 -0
@@ -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
Signature · 1 line
1.9.3
Euan Harris writes ("[PATCH] libxl: Document device parameter of libxl_device_<type>_add functions"):
Quoted 3 lines
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.
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.
Quoted 23 lines
Signed-off-by Euan Harris <[email protected]>--- tools/libxl/libxl.h | 4 ++++ 1 file changed, 4 insertions(+)tools/libxl/libxl.h +4
-0@@ -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 Signature · 1 line
1.9.3
Quoted 11 lines · Ian Jackson
Euan Harris writes ("[PATCH] libxl: Document device parameter of libxl_device_<type>_add functions"):
Quoted 3 lines
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 <[email protected]>Konrad, this should go into 4.5 IMO because it's a doc comment describing existing behaviour which we want everyone to rely on.
Quoted 26 lines
Ian.
Quoted 23 lines
Signed-off-by Euan Harris <[email protected]>--- tools/libxl/libxl.h | 4 ++++ 1 file changed, 4 insertions(+)tools/libxl/libxl.h +4
-0@@ -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 Signature · 1 line
1.9.3
Quoted 6 lines · Konrad Rzeszutek Wilk
Quoted 5 lines · Ian Jackson
Euan Harris writes ("[PATCH] libxl: Document device parameter of libxl_device_<type>_add functions"):
Quoted 3 lines
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.
Quoted 8 lines
Quoted 6 lines
Thanks.
Acked-by Ian Jackson <[email protected]>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 <[email protected]>
and applied, thanks all.