From: Jiri Slaby Date: Wed, 12 Jan 2011 13:53:41 +0000 (+0100) Subject: docco fixes X-Git-Tag: v0.37.1~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=08b4ef91eab11503af868e1d35e1baacb8e26cbe;p=thirdparty%2Flibcgroup.git docco fixes Some typos, articles and similar crap. Signed-off-by: Jiri Slaby Signed-off-by: Jan Safranek --- diff --git a/doc/man/cgconfig.conf.5 b/doc/man/cgconfig.conf.5 index b7218b9a..fea61ea9 100644 --- a/doc/man/cgconfig.conf.5 +++ b/doc/man/cgconfig.conf.5 @@ -5,20 +5,18 @@ cgconfig.conf \- libcgroup configuration file .\"*********************************** .SH DESCRIPTION .B "cgconfig.conf" -is the configuration file used by +is a configuration file used by .B libcgroup to define control groups, their parameters and also mount points. The file consists of .I mount and .I group -sections. -These sections can be in arbitrary order. -Any line starting with '#' is considered as comment line and is -ignored. +sections. These sections can be in arbitrary order. Any line starting with +'#' is considered as a comment line and is ignored. .LP .I mount -section has the form: +section has this form: .RS .nf .ft B @@ -53,7 +51,7 @@ automatically on cgconfig service startup if it does not exist and is deleted on service shutdown. .LP .I group -section has the form: +section has this form: .RS .nf .ft B diff --git a/doc/man/cgrules.conf.5 b/doc/man/cgrules.conf.5 index 9a8a0a35..676f0cc6 100644 --- a/doc/man/cgrules.conf.5 +++ b/doc/man/cgrules.conf.5 @@ -8,12 +8,11 @@ cgrules.conf \- libcgroup configuration file .B "cgrules.conf" configuration file is used by .B libcgroups -to define the control groups to which the process belongs to. +to define control groups to which a process belongs. -The file the contains list of rules which assign -to a defined group/user a control group in a subsystem -(or control groups in subsystems) +The file contains a list of rules which assign to a defined group/user a control +group in a subsystem (or control groups in subsystems). Rules have two formats: @@ -31,8 +30,8 @@ Where: .I user can be: .nf - - an user name - - a group name, with @group syntax + - a user name + - a group name with @group syntax - the wildcard '*', for any user or group - '%', which is equivalent to "ditto" (useful for multi-line rules where different cgroups need to be @@ -69,7 +68,7 @@ can be: '\\' can be used to escape '%' .fi -First rule which matches the criteria will be executed. +First rule which matches the criteria will be executed. Any text starting with '#' is considered as a start of comment line and is @@ -80,41 +79,36 @@ ignored. .nf student devices /usergroup/students .fi -the processes of user -student -in the subsystem 'device' belong to the control group /usergroup/students. +Student's processes in the 'devices' subsystem belong to the control +group /usergroup/students. .nf student:cp devices /usergroup/students/cp .fi -the 'cp' command processes of user -student -in the subsystem 'device' belong to the control group /usergroup/students/cp. +When student executes 'cp' command, the processes in the 'devices' subsystem +belong to the control group /usergroup/students/cp. .nf @admin * admingroup/ .fi -the processes which belong to group -admin -in all subsystems belongs to the control group /admingroup. +Processes started by anybody from admin group no matter in what subsystem belong +to the control group admingroup/. .nf peter cpu test1/ % memory test2/ .fi -First line says Peter's task for cpu controller -belongs to test1 control group -second line says put Peter's tasks for memory controller -belongs to test2/ control group +The first line says Peter's task for cpu controller belongs to test1 control +group. The second one says Peter's tasks for memory controller belong to test2/ +control group. .nf * * default/ .fi -all processes belong in all subsystems -to the control group default/. Because there is applied the first task which is find - -it has a sense to have this row at the end of list to put the -tasks which was not mentioned in the previous rules -to the default/ control group. +All processes in any subsystem belong to the control group default/. Since +the earliest matched rule is applied, it makes sense to have this line +at the end of the list. It will put a task which was not mentioned in the +previous rules to default/ control group.