Update documentation with the new return values

Header file documentation changes; cgroup_create_cgroup() and
cgroup_create_cgroup_from_parent() return ECGROUPNOTEQUAL when create
is successful, but not all controller parameters are successfully
copied.

Signed-off-by: Eric Brower <ebrower@gmail.com>
Signed-off-by: Dhaval Giani <dhaval.giani@gmail.com>

diff --git a/include/libcgroup/groups.h b/include/libcgroup/groups.h
index 29cde70f7ce4f78505675cda5de7bb360463f3a1..3cdb832f42226289b3bac2b8905543e835d8fa7e 100644 (file)
--- a/include/libcgroup/groups.h
+++ b/include/libcgroup/groups.h
@@ -175,6 +175,8 @@ void cgroup_free_controllers(struct cgroup *cgroup);
  * @param ignore_ownership When nozero, all errors are ignored when setting
  *     owner of the group and/or its tasks file.
  *     @todo what is ignore_ownership good for?
+ * @retval #ECGROUPNOTEQUAL if not all specified controller parameters
+ *      were successfully set.
  */
 int cgroup_create_cgroup(struct cgroup *cgroup, int ignore_ownership);
 
@@ -196,6 +198,8 @@ int cgroup_create_cgroup(struct cgroup *cgroup, int ignore_ownership);
  * @param ignore_ownership When nozero, all errors are ignored when setting
  *     owner of the group and/or its tasks file.
  *     @todo what is ignore_ownership good for?
+ * @retval #ECGROUPNOTEQUAL if not all inherited controller parameters
+ *      were successfully set (this is expected).
  */
 int cgroup_create_cgroup_from_parent(struct cgroup *cgroup,
                int ignore_ownership);