libxl: event: Document lifetime API for libxl_childproc_setmode

[Xen-devel] [PATCH] libxl: event: Document lifetime API for libxl_childproc_setmode

Ian Jackson posted 1 patch 4 years, 3 months ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/xen tags/patchew/20200117181207.7087-1-ian.jackson@eu.citrix.com

tools/libxl/libxl_event.h | 2 ++
1 file changed, 2 insertions(+)

Expand all Fold all

[Xen-devel] [PATCH] libxl: event: Document lifetime API for libxl_childproc_setmode

Posted by Ian Jackson 4 years, 3 months ago

There is already an identical comment for
libxl_osevent_register_hooks.

libxl_childproc_setmode's hooks parameter has the same property and
this should be documented.

Reported-by; George Dunlap <george.dunlap@citrix.com>
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
 tools/libxl/libxl_event.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/tools/libxl/libxl_event.h b/tools/libxl/libxl_event.h
index d1517f7456..8d0aa6417e 100644
--- a/tools/libxl/libxl_event.h
+++ b/tools/libxl/libxl_event.h
@@ -548,6 +548,8 @@ typedef struct {
  * May not be called when libxl might have any child processes, or the
  * behaviour is undefined.  So it is best to call this at
  * initialisation.
+ *
+ * The value *hooks is not copied and must outlast the libxl_ctx.
  */
 void libxl_childproc_setmode(libxl_ctx *ctx, const libxl_childproc_hooks *hooks,
                              void *user);
-- 
2.11.0


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

Re: [Xen-devel] [PATCH] libxl: event: Document lifetime API for libxl_childproc_setmode

Posted by Wei Liu 4 years, 3 months ago

On Fri, Jan 17, 2020 at 06:12:07PM +0000, Ian Jackson wrote:
> There is already an identical comment for
> libxl_osevent_register_hooks.
> 
> libxl_childproc_setmode's hooks parameter has the same property and
> this should be documented.
> 
> Reported-by; George Dunlap <george.dunlap@citrix.com>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>

Acked-by: Wei Liu <wl@xen.org>

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