aboutsummaryrefslogtreecommitdiff
path: root/include/libvfio-user.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libvfio-user.h')
-rw-r--r--include/libvfio-user.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/libvfio-user.h b/include/libvfio-user.h
index 90dd21a..a43f38a 100644
--- a/include/libvfio-user.h
+++ b/include/libvfio-user.h
@@ -181,7 +181,8 @@ vfu_get_private(vfu_ctx_t *vfu_ctx);
typedef void (vfu_log_fn_t)(vfu_ctx_t *vfu_ctx, int level, const char *msg);
/**
- * Log to the logging function configured for this context.
+ * Log to the logging function configured for this context. The format should
+ * not include a new line.
*/
void
vfu_log(vfu_ctx_t *vfu_ctx, int level, const char *fmt, ...) \
@@ -192,6 +193,9 @@ vfu_log(vfu_ctx_t *vfu_ctx, int level, const char *fmt, ...) \
* @vfu_ctx: the libvfio-user context
* @log: logging function
* @level: logging level as defined in syslog(3)
+ *
+ * The log handler is expected to add a newline (that is, log messages do not
+ * include a newline).
*/
int
vfu_setup_log(vfu_ctx_t *vfu_ctx, vfu_log_fn_t *log, int level);