diff options
| author | Dmitri Pal <dpal@redhat.com> | 2012-12-04 19:46:05 -0500 |
|---|---|---|
| committer | Ondrej Kos <okos@redhat.com> | 2012-12-06 14:23:26 +0100 |
| commit | 58d87578aa10693e6cb968f0aac804ee611ea4e5 (patch) | |
| tree | a8db5bc1ea41d44571516b87634a88b69db8ea11 | |
| parent | 854d077f8a7ded3f5c25f58fa4bfc46aa55095db (diff) | |
| download | ding-libs-58d87578aa10693e6cb968f0aac804ee611ea4e5.tar.gz ding-libs-58d87578aa10693e6cb968f0aac804ee611ea4e5.tar.xz ding-libs-58d87578aa10693e6cb968f0aac804ee611ea4e5.zip | |
Update comments in the public interface
| -rw-r--r-- | ini/ini_configobj.h | 9 |
1 files 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 |