Documentation fixes for config_setting_remove
authorJose Luis Tallon <jltallon@adv-solutions.net>
Wed, 30 Dec 2015 19:02:53 +0000 (20:02 +0100)
committerJose Luis Tallon <jltallon@adv-solutions.net>
Wed, 30 Dec 2015 19:02:53 +0000 (20:02 +0100)
doc/libconfig.texi

index 914793c..2f1938b 100644 (file)
@@ -1091,6 +1091,10 @@ This function removes and destroys the setting named @var{name} from
 the parent setting @var{parent}, which must be a group. Any child
 settings of the setting are recursively destroyed as well.
 
+The @var{name} parameter can also specify a setting @i{path} relative to 
+the provided @var{parent}.
+(In that case, the setting will be looked up and removed.)
+
 The function returns @code{CONFIG_TRUE} on success. If @var{parent} is
 not a group, or if it has no setting with the given name, it returns
 @code{CONFIG_FALSE}.