Re: [Xen-devel] [PATCH V4 03/24] libxl.h: document the paradigm of using libxl types

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Thu, 2014-05-01 at 13:58 +0100, Wei Liu wrote:
> Signed-off-by: Wei Liu <wei.liu2@xxxxxxxxxx>

I think this reflects reality even if it's not what we would actually
have wanted.

Acked-by: Ian Campbell <ian.campbell@xxxxxxxxxx>


> ---
>  tools/libxl/libxl.h |    5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
> index 2f14d26..b33460b 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_<type>_init(<type> *p):
>   *
>   *    Initialises the members of "p" to all defaults. These may either



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel