From mboxrd@z Thu Jan 1 00:00:00 1970 From: Wei Liu Subject: [PATCH V3 02/13] libxl.h: document the paradigm of using libxl types Date: Wed, 23 Apr 2014 17:59:12 +0100 Message-ID: <1398272363-12133-3-git-send-email-wei.liu2@citrix.com> References: <1398272363-12133-1-git-send-email-wei.liu2@citrix.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <1398272363-12133-1-git-send-email-wei.liu2@citrix.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: xen-devel@lists.xen.org Cc: Wei Liu , ian.jackson@eu.citrix.com, ian.campbell@citrix.com List-Id: xen-devel@lists.xenproject.org Signed-off-by: Wei Liu --- tools/libxl/libxl.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h index b2c3015..47ddd65 100644 --- a/tools/libxl/libxl.h +++ b/tools/libxl/libxl.h @@ -233,6 +233,11 @@ * libxl_types.idl). The library provides a common set of methods for * initialising and freeing these types. * + * The paradigm of using libxl types is that user always calls "init" + * function before using a type, and always calls "dispose" after using + * a type to clean up, regardless of the operations on this type + * succeed or fail. See xl code for examples. + * * void libxl__init( *p): * * Initialises the members of "p" to all defaults. These may either -- 1.7.10.4