Mailing List Archive

# HG changeset patch
# User Ian Jackson <Ian.Jackson@eu.citrix.com>
# Date 1296239845 0
# Node ID 5eaf9405ed51debda48b6177fdfa7471d52f7d87
# Parent ccfa0527893e2f6278be8d00b5d930f1d6cce45d
libxl: internals: document the error behaviour of various libxl__xs_* functions

Many of the functions in libxl_xshelp.c simply return 0 on error, and
leave the errno value from xenstore in errno. Document this more
clearly.

Also fix a >75 column line.

No functional change.

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl_internal.h | 12 ++++++++++--
1 files changed, 10 insertions(+), 2 deletions(-)

diff -r ccfa0527893e -r 5eaf9405ed51 tools/libxl/libxl_internal.h
--- a/tools/libxl/libxl_internal.h Fri Jan 28 18:36:54 2011 +0000
+++ b/tools/libxl/libxl_internal.h Fri Jan 28 18:37:25 2011 +0000
@@ -140,13 +140,21 @@ _hidden char *libxl__dirname(libxl__gc *
_hidden char *libxl__dirname(libxl__gc *gc, const char *s);

_hidden char **libxl__xs_kvs_of_flexarray(libxl__gc *gc, flexarray_t *array, int length);
+
_hidden int libxl__xs_writev(libxl__gc *gc, xs_transaction_t t,
char *dir, char **kvs);
_hidden int libxl__xs_write(libxl__gc *gc, xs_transaction_t t,
char *path, char *fmt, ...) PRINTF_ATTRIBUTE(4, 5);
-_hidden char *libxl__xs_get_dompath(libxl__gc *gc, uint32_t domid); // logs errs
+ /* Each fn returns 0 on success.
+ * On error: returns -1, sets errno (no logging) */
+
+_hidden char *libxl__xs_get_dompath(libxl__gc *gc, uint32_t domid);
+ /* On error: logs, returns NULL, sets errno. */
+
_hidden char *libxl__xs_read(libxl__gc *gc, xs_transaction_t t, char *path);
-_hidden char **libxl__xs_directory(libxl__gc *gc, xs_transaction_t t, char *path, unsigned int *nb);
+_hidden char **libxl__xs_directory(libxl__gc *gc, xs_transaction_t t,
+ char *path, unsigned int *nb);
+ /* On error: returns NULL, sets errno (no logging) */

/* from xl_dom */
_hidden int libxl__domain_is_hvm(libxl_ctx *ctx, uint32_t domid);

_______________________________________________
Xen-changelog mailing list
Xen-changelog@lists.xensource.com
http://lists.xensource.com/xen-changelog