API doc: update note for get_config_item

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

Signed-off-by: 0x0916 <w@laoqinren.net>

diff --git a/src/lxc/lxccontainer.h b/src/lxc/lxccontainer.h
index a58d3450a27b0630929f14555c13e9a11a4af235..8fe4e37e58865a7bb9a4f184db71fd0fe144a57e 100644 (file)
--- a/src/lxc/lxccontainer.h
+++ b/src/lxc/lxccontainer.h
@@ -406,8 +406,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);