From 58d87578aa10693e6cb968f0aac804ee611ea4e5 Mon Sep 17 00:00:00 2001 From: Dmitri Pal Date: Tue, 4 Dec 2012 19:46:05 -0500 Subject: Update comments in the public interface --- ini/ini_configobj.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/ini/ini_configobj.h b/ini/ini_configobj.h index 0ebe17d..5b4fc81 100644 --- a/ini/ini_configobj.h +++ b/ini/ini_configobj.h @@ -658,8 +658,8 @@ int ini_config_changed(struct ini_cfgfile *file_ctx1, * * Function parses the file. It is assumed that * the configuration object was just created. - * Using one configuration object in more than one - * parsing operation would lead to undetermined results. + * Using a non empty configuration object in + * a parsing operation would fail with EINVAL. * * @param[in] file_ctx Configuration file object. * @param[out] ini_config Configuration object. @@ -691,6 +691,11 @@ int ini_config_copy(struct ini_cfgobj *ini_config, * * Function merges configuration objects and creates * a new resulting object out of the two. + * IMPORTANT: Use same collision flags for reading + * of the files and then merging. + * Mixing the flags would lead to strange results + * that would be hard to debug. + * * * @param[in] first A base object * the other object will -- cgit