From a8c3f5121fac2cc4f8e3221a5a06b63d2e9c6f02 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 27 Sep 2013 00:05:07 +0200 Subject: [PATCH] man: drop references to "cgroup" wher appropriate Since cgroups are mostly now an implementation detail of systemd lets deemphasize it a bit in the man pages. This renames systemd.cgroup(5) to systemd.resource-control(5) and uses the term "resource control" rather than "cgroup" where appropriate. This leaves the word "cgroup" in at a couple of places though, like for example systemd-cgtop and systemd-cgls where cgroup stuff is at the core of what is happening. Conflicts: man/systemd.exec.xml --- Makefile-man.am | 2 +- man/loginctl.xml | 4 ++-- man/machinectl.xml | 4 ++-- man/pam_systemd.xml | 2 +- man/systemctl.xml | 14 ++++++------- man/systemd-cgls.xml | 6 +++--- man/systemd-cgtop.xml | 4 ++-- man/systemd.exec.xml | 5 +++-- man/systemd.mount.xml | 6 +++--- ...emd.cgroup.xml => systemd.resource-control.xml} | 24 ++++++++++------------ man/systemd.scope.xml | 2 +- man/systemd.service.xml | 6 +++--- man/systemd.slice.xml | 22 ++++++++++---------- man/systemd.socket.xml | 12 +++++------ man/systemd.swap.xml | 6 +++--- 15 files changed, 59 insertions(+), 60 deletions(-) rename man/{systemd.cgroup.xml => systemd.resource-control.xml} (96%) diff --git a/Makefile-man.am b/Makefile-man.am index 1f63595..c8a4342 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -78,7 +78,6 @@ MANPAGES += \ man/systemd-update-utmp.service.8 \ man/systemd.1 \ man/systemd.automount.5 \ - man/systemd.cgroup.5 \ man/systemd.device.5 \ man/systemd.exec.5 \ man/systemd.journal-fields.7 \ @@ -86,6 +85,7 @@ MANPAGES += \ man/systemd.mount.5 \ man/systemd.path.5 \ man/systemd.preset.5 \ + man/systemd.resource-control.5 \ man/systemd.scope.5 \ man/systemd.service.5 \ man/systemd.slice.5 \ diff --git a/man/loginctl.xml b/man/loginctl.xml index ef0dfc0..1b54ff7 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -117,8 +117,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree entries. diff --git a/man/machinectl.xml b/man/machinectl.xml index 5efa3a5..2ed9f2e 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -117,8 +117,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree entries. diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 951ae20..0e25a4a 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -55,7 +55,7 @@ Description pam_systemd registers user - sessions in the systemd login manager + sessions with the systemd login manager systemd-logind.service8, and hence the systemd control group hierarchy. diff --git a/man/systemctl.xml b/man/systemctl.xml index 51c34b7..a70c964 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -187,7 +187,7 @@ systemctl start foo - Do not ellipsize unit names, cgroup members, and + Do not ellipsize unit names, process tree entries, and truncate unit descriptions in the output of list-units and list-jobs. @@ -724,14 +724,14 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Set the specified unit properties at runtime where this is supported. This allows changing configuration - parameter properties such as resource management controls at + parameter properties such as resource control settings at runtime. Not all properties may be changed at runtime, but - many resource management settings (primarily those in - systemd.cgroup5) + many resource control settings (primarily those in + systemd.resource-control5) may. The changes are applied instantly, and stored on disk for future boots, unless is - passed, in which case the settings only apply until the next - reboot. The syntax of the property assignment follows + passed, in which case the settings only apply until the + next reboot. The syntax of the property assignment follows closely the syntax of assignments in unit files. Example: systemctl set-property foobar.service CPUShares=777 @@ -1299,7 +1299,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service journalctl1, loginctl1, systemd.unit5, - systemd.cgroup5, + systemd.resource-management5, systemd.special7, wall1, systemd.preset5 diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index fcaf894..432706b 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -116,8 +116,8 @@ - Do not ellipsize cgroup - members. + Do not ellipsize + process tree members. @@ -132,7 +132,7 @@ - Limit cgroups shown to + Limit control groups shown to the part corresponding to the container MACHINE. diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index 51549c4..7faedfb 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -80,7 +80,7 @@ MemoryAccounting=1 and BlockIOAccounting=1 settings in the unit files in question (See - systemd.cgroup5 + systemd.resource-control5 for details). To emphasize this: unless @@ -274,7 +274,7 @@ systemd1, systemctl1, systemd-cgls1, - systemd.cgroup5, + systemd.resource-control5, top1 diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 5721dc1..28d7fd4 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1017,8 +1017,9 @@ systemd.swap5, systemd.mount5, systemd.kill5, - systemd.cgroup5, - systemd.directives7 + systemd.resource-control5, + systemd.directives7, + exec3 diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index e5b5c3c..48af1ca 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Note that the User= and Group= options are not particularly useful for mount units specifying a Type= option or @@ -302,7 +302,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.device5, proc5, diff --git a/man/systemd.cgroup.xml b/man/systemd.resource-control.xml similarity index 96% rename from man/systemd.cgroup.xml rename to man/systemd.resource-control.xml index cc0eb15..2427f208 100644 --- a/man/systemd.cgroup.xml +++ b/man/systemd.resource-control.xml @@ -22,9 +22,9 @@ You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> - + - systemd.cgroup + systemd.resource-control systemd @@ -38,13 +38,13 @@ along with systemd; If not, see . - systemd.cgroup + systemd.resource-control 5 - systemd.cgroup - Control Group configuration unit settings + systemd.resource-control + Resource control unit settings @@ -63,12 +63,10 @@ along with systemd; If not, see . Unit configuration files for services, slices, scopes, sockets, mount points, and swap devices share a subset of - configuration options which configure the control group settings - for spawned processes. - - Control Groups is a concept for organizing processes in a - hierarch tree of named groups for the purpose of resource - management. + configuration options for resource control of spawned + processes. Internally, this relies on the the Control Groups + kernel concept for organizing processes in a hierarchial tree of + named groups for the purpose of resource management. This man page lists the configuration options shared by those six unit types. See @@ -82,7 +80,7 @@ along with systemd; If not, see . and systemd.swap5 for more information on the specific unit configuration files. The - execution-specific configuration options are configured in the + resource control configuration options are configured in the [Slice], [Scope], [Service], [Socket], [Mount], or [Swap] sections, depending on the unit type. @@ -91,7 +89,7 @@ along with systemd; If not, see . Options Units of the types listed above can have settings - for cgroup configuration: + for resource control configuration: diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index e8fa1ae..9813e0a 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -86,7 +86,7 @@ along with systemd; If not, see . systemd1, systemd-run1, systemd.unit5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.directives7. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 8eda85f..45f96fa 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes of the service are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Unless DefaultDependencies= @@ -1006,7 +1006,7 @@ systemctl8, systemd.unit5, systemd.exec5, - systemd.cgroup5, + systemd.resource-control5, systemd.kill5, systemd.directives7 diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index b7b0622..4d27ddf 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -58,14 +58,14 @@ along with systemd; If not, see . .slice encodes information about a slice which is a concept for hierarchially managing resources of a group of processes. This management is performed by creating a node in the - control group tree. Units that manage processes (primarilly scope - and service units) may be assigned to a specific slice. For each - slice, certain resource limits may the be set that apply to all - processes of all units contained in that slice. Slices are - organized hierarchially in a tree. The name of the slice encodes - the location in the tree. The name consists of a dash-separated - series of names, which describes the path to the slice from the - root slice. The root slice is named, + Linux Control Group (cgroup) tree. Units that manage processes + (primarilly scope and service units) may be assigned to a specific + slice. For each slice, certain resource limits may the be set that + apply to all processes of all units contained in that + slice. Slices are organized hierarchially in a tree. The name of + the slice encodes the location in the tree. The name consists of a + dash-separated series of names, which describes the path to the + slice from the root slice. The root slice is named, -.slice. Example: foo-bar.slice is a slice that is located within foo.slice, which in turn is located in @@ -89,9 +89,9 @@ along with systemd; If not, see . files. The common configuration items are configured in the generic [Unit] and [Install] sections. The slice specific configuration options are configured in - the [Slice] section. Currently, only generic cgroup settings + the [Slice] section. Currently, only generic resource control settings as described in - systemd.cgroup7 are allowed. + systemd.resource-control7 are allowed. Unless DefaultDependencies=false @@ -110,7 +110,7 @@ along with systemd; If not, see . systemd1, systemd.unit5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.scope5, systemd.special7, diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 419a38c..8c88d9f 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -78,11 +78,11 @@ commands are executed in, and in systemd.kill5, - which define the way the processes are - terminated, and in - systemd.cgroup5, - which configure control group settings for the - processes of the service. + which define the way the processes are terminated, and + in + systemd.resource-control5, + which configure resource control settings for the + processes of the socket. For each socket file a matching service file (see @@ -712,7 +712,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.service5, systemd.directives7 diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 18ef5b0..813ae6c 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -76,8 +76,8 @@ systemd.kill5, which define the way the processes are terminated, and in - systemd.cgroup5, - which configure control group settings for the + systemd.resource-control5, + which configure resource control settings for the processes of the service. Swap units must be named after the devices @@ -206,7 +206,7 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.cgroup5, + systemd.resource-control5, systemd.device5, systemd.mount5, swapon8,