[lxc-devel] [lxc/master] API doc: update note for get_config_item

[0x0916 on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 392 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20170626/7bc6d032/attachment.bin>
-------------- next part --------------
From 13a4215bfb8af343c132fba7a8247f95ada137ea Mon Sep 17 00:00:00 2001
From: 0x0916 <w at laoqinren.net>
Date: Mon, 26 Jun 2017 17:28:47 +0800
Subject: [PATCH] API doc: update note for get_config_item

Fix issue: https://github.com/lxc/lxc/issues/505

Signed-off-by: 0x0916 <w at laoqinren.net>
---
 src/lxc/lxccontainer.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/lxc/lxccontainer.h b/src/lxc/lxccontainer.h
index 11f5523af..fe8e73811 100644
--- a/src/lxc/lxccontainer.h
+++ b/src/lxc/lxccontainer.h
@@ -408,8 +408,8 @@ struct lxc_container {
 	 *  \p retv by initially passing its value as \c NULL and considering the return value.
 	 *  This function can then be called again passing a newly-allocated suitably-sized buffer.
 	 * \note If \p retv is NULL, \p inlen is ignored.
-	 * \note If \p inlen is smaller than required, the value written
-	 *  to \p retv will be truncated.
+	 * \note If \p inlen is smaller than required, nothing will be written to \p retv and still return
+	 *  the length of config item value.
 	 */
 	int (*get_config_item)(struct lxc_container *c, const char *key, char *retv, int inlen);