chiark / gitweb /
man: update scope unit man page a bit
authorLennart Poettering <lennart@poettering.net>
Fri, 19 Jul 2013 17:04:17 +0000 (19:04 +0200)
committerLennart Poettering <lennart@poettering.net>
Fri, 19 Jul 2013 17:04:17 +0000 (19:04 +0200)
TODO
man/systemd.cgroup.xml
man/systemd.scope.xml
man/systemd.snapshot.xml

diff --git a/TODO b/TODO
index a4535b5..79be347 100644 (file)
--- a/TODO
+++ b/TODO
@@ -46,7 +46,7 @@ CGroup Rework Completion:
 * introduce high-level settings for RT budget, swappiness
 
 * wiki: document new bus APIs of PID 1 (transient units, Reloading signal)
-* review: scope units, slice units, systemctl commands
+* review: slice units, systemctl commands
 
 * Send SIGHUP and SIGTERM in session scopes
 
index c2a823e..12b19f5 100644 (file)
@@ -44,7 +44,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
   <refnamediv>
     <refname>systemd.cgroup</refname>
-    <refpurpose>Cgroup configuration unit settings</refpurpose>
+    <refpurpose>Control Group configuration unit settings</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
@@ -66,6 +66,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     configuration options which configure the control group settings
     for spawned processes.</para>
 
+    <para>Control Groups is a concept for organizing processes in a
+    hierarch tree of named groups for the purpose of resource
+    management.</para>
+
     <para>This man page lists the configuration options shared by
     those six unit types. See
     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
index 126440a..1400f8f 100644 (file)
@@ -54,25 +54,20 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para>A unit configuration file whose name ends in
-    <literal>.scope</literal> encodes information about a unit created
-    by systemd to encapsulate processes not launched by systemd
-    itself. This management is performed by creating a node in the
-    control group tree. Processes are moved into the scope by means
-    of the D-Bus API.
-    <command>systemd-run <option>--scope</option></command> can be
-    used to easily launch a command in a new scope unit.</para>
-
-    <para>See
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    for the common options of all unit configuration
-    files. The common configuration items are configured
-    in the generic [Unit] and [Install] sections. The
-    scope specific configuration options are configured in
-    the [Scope] section. Currently, only generic cgroup settings
-    as described in
-    <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>7</manvolnum></citerefentry> are allowed.
-    </para>
+    <para>Scope units are not configured via unit configuration files,
+    but are only created programmatically using the bus interfaces of
+    systemd. They are named similar to filenames. A unit whose name
+    ends in <literal>.scope</literal> refers to a scope unit. Scopes
+    units manage a set of system processes. Unlike service units scope
+    units manage externally created processes, and do not fork off
+    processes on its own.</para>
+
+    <para>The main purpose of scope units is grouping worker processes
+    of a system service for organization and resource management.</para>
+
+    <para><command>systemd-run <option>--scope</option></command> may
+    be used to easily launch a command in a new scope unit from the
+    command line.</para>
 
     <para>Unless <varname>DefaultDependencies=false</varname>
     is used, scope units will implicitly have dependencies of
index 4e8d5a9..1bb074a 100644 (file)
@@ -56,7 +56,7 @@
 
                 <para>Snapshot units are not configured via unit
                 configuration files. Nonetheless they are named
-                similar to filenames. A unit name whose name ends in
+                similar to filenames. A unit whose name ends in
                 <literal>.snapshot</literal> refers to a dynamic
                 snapshot of the systemd runtime state.</para>