From 7e52aa119ac9aff854f4546c883da45626e67774 Mon Sep 17 00:00:00 2001 From: Eric Brower Date: Mon, 26 Jul 2010 22:49:37 -0700 Subject: [PATCH] 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 --- include/libcgroup/groups.h | 4 ++++ 1 file changed, 4 insertions(+) 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); -- 2.47.2