From: Eric Brower Date: Tue, 27 Jul 2010 05:49:37 +0000 (-0700) Subject: Update documentation with the new return values X-Git-Tag: v0.37.1~60 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7e52aa119ac9aff854f4546c883da45626e67774;p=thirdparty%2Flibcgroup.git 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 Signed-off-by: Dhaval Giani --- diff --git a/include/libcgroup/groups.h b/include/libcgroup/groups.h index 29cde70f..3cdb832f 100644 --- 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);