From: Wei Liu <wei.liu2@citrix.com>
Date: Tue, 13 May 2014 21:53:49 +0000 (+0100)
Subject: libxl.h: document the paradigm of using libxl types
X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~4976
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=00bfad10f82a0b5554a96e37aed7187c6f374112;p=xen.git

libxl.h: document the paradigm of using libxl types

Signed-off-by: Wei Liu <wei.liu2@citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
---

diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index c7aa817762..896ecabdf3 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -245,6 +245,16 @@
  * libxl_types.idl). The library provides a common set of methods for
  * initialising and freeing these types.
  *
+ * IDL-generated libxl types should be used as follows: the user must
+ * always call the "init" function before using a type, even if the
+ * variable is simply being passed by reference as an out parameter
+ * to a libxl function.  The user must always calls "dispose" exactly
+ * once afterwards, to clean up, regardless of whether operations on
+ * this object succeeded or failed.  See the xl code for examples.
+ *
+ * "init" is idempotent.  We intend that "dispose" will become
+ * idempotent, but this is not currently the case.
+ *
  * void libxl_<type>_init(<type> *p):
  *
  *    Initialises the members of "p" to all defaults. These may either