From aed5cb03db916de7e685eaf59975c41326e4f778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 16 Apr 2018 18:00:33 +0200 Subject: [PATCH] man: merge two sections into two subsections of one section Those are very close subjects that are a good fit for one section. --- man/systemd.automount.xml | 40 ++++++++++-------- man/systemd.device.xml | 29 +++++++------ man/systemd.mount.xml | 84 ++++++++++++++++++++------------------ man/systemd.path.xml | 50 ++++++++++++----------- man/systemd.scope.xml | 42 ++++++++++--------- man/systemd.service.xml | 86 ++++++++++++++++++++------------------- man/systemd.slice.xml | 40 ++++++++++-------- man/systemd.socket.xml | 80 +++++++++++++++++++----------------- man/systemd.swap.xml | 48 ++++++++++++---------- man/systemd.target.xml | 42 ++++++++++--------- man/systemd.timer.xml | 38 ++++++++++------- man/systemd.unit.xml | 58 +++++++++++++------------- 12 files changed, 343 insertions(+), 294 deletions(-) diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 5c58c870862..44add70d212 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -76,30 +76,34 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - If an automount unit is beneath another mount unit in the - file system hierarchy, both a requirement and an ordering - dependency between both units are created automatically. + The following dependencies are implicitly added: - An implicit Before= dependency is created - between an automount unit and the mount unit it activates. - - + + If an automount unit is beneath another mount unit in the + file system hierarchy, both a requirement and an ordering + dependency between both units are created automatically. - - Default Dependencies + An implicit Before= dependency is created + between an automount unit and the mount unit it activates. + + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - Automount units acquire automatic Before= and - Conflicts= on umount.target in order to be stopped during - shutdown. - + The following dependencies are added unless DefaultDependencies=no is set: + + + Automount units acquire automatic Before= and + Conflicts= on umount.target in order to be stopped during + shutdown. + + diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 3be5fc0e902..2509b242bab 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -77,25 +77,28 @@ corresponding device generates a changed event. Other units can use ReloadPropagatedFrom= to react to that event - - Implicit Dependencies + Automatic Dependencies - Many unit types automatically acquire dependencies on device - units of devices they require. For example, - .socket unit acquire dependencies on the - device units of the network interface specified in - BindToDevice=. Similar, swap and mount units - acquire dependencies on the units encapsulating their backing - block devices. - + + Implicit Dependencies - - Default Dependencies + Many unit types automatically acquire dependencies on device + units of devices they require. For example, + .socket unit acquire dependencies on the + device units of the network interface specified in + BindToDevice=. Similar, swap and mount units + acquire dependencies on the units encapsulating their backing + block devices. + - There are no default dependencies for device units. + + Default Dependencies + + There are no default dependencies for device units. + diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index cb23e5e84a0..cdba7a20b9c 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -102,57 +102,61 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - If a mount unit is beneath another mount unit in the file - system hierarchy, both a requirement dependency and an ordering - dependency between both units are created automatically. + The following dependencies are implicitly added: - Block device backed file systems automatically gain - BindsTo= and After= type - dependencies on the device unit encapsulating the block - device (see below). + + If a mount unit is beneath another mount unit in the file + system hierarchy, both a requirement dependency and an ordering + dependency between both units are created automatically. - If traditional file system quota is enabled for a mount - unit, automatic Wants= and - Before= dependencies on - systemd-quotacheck.service and - quotaon.service are added. + Block device backed file systems automatically gain + BindsTo= and After= type + dependencies on the device unit encapsulating the block + device (see below). - Additional implicit dependencies may be added as result of - execution and resource control parameters as documented in - systemd.exec5 - and - systemd.resource-control5. - - - + If traditional file system quota is enabled for a mount + unit, automatic Wants= and + Before= dependencies on + systemd-quotacheck.service and + quotaon.service are added. - - Default Dependencies + Additional implicit dependencies may be added as result of + execution and resource control parameters as documented in + systemd.exec5 + and + systemd.resource-control5. + + + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - All mount units acquire automatic Before= and Conflicts= on - umount.target in order to be stopped during shutdown. + The following dependencies are added unless DefaultDependencies=no is set: - Mount units referring to local file systems automatically gain - an After= dependency on local-fs-pre.target. + + All mount units acquire automatic Before= and Conflicts= on + umount.target in order to be stopped during shutdown. - Network mount units - automatically acquire After= dependencies on remote-fs-pre.target, - network.target and network-online.target. Towards the latter a - Wants= unit is added as well. - + Mount units referring to local file systems automatically gain + an After= dependency on local-fs-pre.target. - Mount units referring to local and network file systems are - distinguished by their file system type specification. In some cases this is not sufficient (for example network - block device based mounts, such as iSCSI), in which case may be added to the mount option - string of the unit, which forces systemd to consider the mount unit a network mount. + Network mount units + automatically acquire After= dependencies on remote-fs-pre.target, + network.target and network-online.target. Towards the latter a + Wants= unit is added as well. + + + Mount units referring to local and network file systems are distinguished by their file system type + specification. In some cases this is not sufficient (for example network block device based mounts, such as + iSCSI), in which case may be added to the mount option string of the unit, which forces + systemd to consider the mount unit a network mount. + diff --git a/man/systemd.path.xml b/man/systemd.path.xml index dc218853091..513ca706927 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -71,36 +71,40 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - If a path unit is beneath another mount unit in the file - system hierarchy, both a requirement and an ordering dependency - between both units are created automatically. + The following dependencies are implicitly added: - An implicit Before= dependency is added - between a path unit and the unit it is supposed to activate. - - + + If a path unit is beneath another mount unit in the file + system hierarchy, both a requirement and an ordering dependency + between both units are created automatically. - - Default Dependencies + An implicit Before= dependency is added + between a path unit and the unit it is supposed to activate. + + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - Path units will automatically have dependencies of type Before= on - paths.target, - dependencies of type After= and Requires= on - sysinit.target, and have dependencies of type Conflicts= and - Before= on shutdown.target. These ensure that path units are terminated - cleanly prior to system shutdown. Only path units involved with early boot or late system shutdown should - disable DefaultDependencies= option. - + The following dependencies are added unless DefaultDependencies=no is set: - + + Path units will automatically have dependencies of type Before= on + paths.target, + dependencies of type After= and Requires= on + sysinit.target, and have dependencies of type Conflicts= and + Before= on shutdown.target. These ensure that path units are terminated + cleanly prior to system shutdown. Only path units involved with early boot or late system shutdown should + disable DefaultDependencies= option. + + + + diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index cf888696cdc..317500c3f62 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -64,29 +64,33 @@ - Implicit Dependencies + Automatic Dependencies - Implicit dependencies may be added as result of - resource control parameters as documented in - systemd.resource-control5. - + + Implicit Dependencies - - Default Dependencies + Implicit dependencies may be added as result of + resource control parameters as documented in + systemd.resource-control5. + - The following dependencies are added unless - DefaultDependencies=no is set: + + Default Dependencies - - Scope units will automatically have dependencies of - type Conflicts= and - Before= on - shutdown.target. These ensure - that scope units are removed prior to system - shutdown. Only scope units involved with early boot or - late system shutdown should disable - DefaultDependencies= option. - + The following dependencies are added unless + DefaultDependencies=no is set: + + + Scope units will automatically have dependencies of + type Conflicts= and + Before= on + shutdown.target. These ensure + that scope units are removed prior to system + shutdown. Only scope units involved with early boot or + late system shutdown should disable + DefaultDependencies= option. + + diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 614a60489d8..5c29ecb4609 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -92,55 +92,59 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - Services with Type=dbus set automatically - acquire dependencies of type Requires= and - After= on - dbus.socket. + The following dependencies are implicitly added: - Socket activated services are automatically ordered after - their activating .socket units via an - automatic After= dependency. - Services also pull in all .socket units - listed in Sockets= via automatic - Wants= and After= dependencies. - + + Services with Type=dbus set automatically + acquire dependencies of type Requires= and + After= on + dbus.socket. - Additional implicit dependencies may be added as result of - execution and resource control parameters as documented in - systemd.exec5 - and - systemd.resource-control5. - + Socket activated services are automatically ordered after + their activating .socket units via an + automatic After= dependency. + Services also pull in all .socket units + listed in Sockets= via automatic + Wants= and After= dependencies. + - - Default Dependencies + Additional implicit dependencies may be added as result of + execution and resource control parameters as documented in + systemd.exec5 + and + systemd.resource-control5. + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - Service units will have dependencies of type Requires= and - After= on sysinit.target, a dependency of type After= on - basic.target as well as dependencies of type Conflicts= and - Before= on shutdown.target. These ensure that normal service units pull in - basic system initialization, and are terminated cleanly prior to system shutdown. Only services involved with early - boot or late system shutdown should disable this option. + The following dependencies are added unless DefaultDependencies=no is set: - Instanced service units (i.e. service units with an @ in their name) are assigned by - default a per-template slice unit (see - systemd.slice5), named after the - template unit, containing all instances of the specific template. This slice is normally stopped at shutdown, - together with all template instances. If that is not desired, set DefaultDependencies=no in the - template unit, and either define your own per-template slice unit file that also sets - DefaultDependencies=no, or set Slice=system.slice (or another suitable slice) - in the template unit. Also see - systemd.resource-control5. - - + + Service units will have dependencies of type Requires= and + After= on sysinit.target, a dependency of type After= on + basic.target as well as dependencies of type Conflicts= and + Before= on shutdown.target. These ensure that normal service units pull in + basic system initialization, and are terminated cleanly prior to system shutdown. Only services involved with early + boot or late system shutdown should disable this option. + + Instanced service units (i.e. service units with an @ in their name) are assigned by + default a per-template slice unit (see + systemd.slice5), named after the + template unit, containing all instances of the specific template. This slice is normally stopped at shutdown, + together with all template instances. If that is not desired, set DefaultDependencies=no in the + template unit, and either define your own per-template slice unit file that also sets + DefaultDependencies=no, or set Slice=system.slice (or another suitable slice) + in the template unit. Also see + systemd.resource-control5. + + + diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index af954559167..4e87f98c9f4 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -85,29 +85,33 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - Slice units automatically gain dependencies of type - After= and Requires= on - their immediate parent slice unit. - - + The following dependencies are implicitly added: - - Default Dependencies + + Slice units automatically gain dependencies of type + After= and Requires= on + their immediate parent slice unit. + + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - Slice units will automatically have dependencies of type Conflicts= and - Before= on - shutdown.target. These ensure that slice units are removed prior to system shutdown. - Only slice units involved with late system shutdown should disable - DefaultDependencies= option. - + The following dependencies are added unless DefaultDependencies=no is set: + + + Slice units will automatically have dependencies of type Conflicts= and + Before= on + shutdown.target. These ensure that slice units are removed prior to system shutdown. + Only slice units involved with late system shutdown should disable + DefaultDependencies= option. + + diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 6e5ba6af724..d11fecd9b77 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -110,53 +110,57 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - Socket units automatically gain a Before= - dependency on the service units they activate. + The following dependencies are implicitly added: - Socket units referring to file system paths (such as AF_UNIX - sockets or FIFOs) implicitly gain Requires= and - After= dependencies on all mount units - necessary to access those paths. + + Socket units automatically gain a Before= + dependency on the service units they activate. - Socket units using the BindToDevice= - setting automatically gain a BindsTo= and - After= dependency on the device unit - encapsulating the specified network interface. - + Socket units referring to file system paths (such as AF_UNIX + sockets or FIFOs) implicitly gain Requires= and + After= dependencies on all mount units + necessary to access those paths. - Additional implicit dependencies may be added as result of - execution and resource control parameters as documented in - systemd.exec5 - and - systemd.resource-control5. - + Socket units using the BindToDevice= + setting automatically gain a BindsTo= and + After= dependency on the device unit + encapsulating the specified network interface. + - - Default Dependencies + Additional implicit dependencies may be added as result of + execution and resource control parameters as documented in + systemd.exec5 + and + systemd.resource-control5. + - The following dependencies are added unless - DefaultDependencies=no is set: + + Default Dependencies - - Socket units automatically gain a - Before= dependency on - sockets.target. + The following dependencies are added unless + DefaultDependencies=no is set: - Socket units automatically gain a pair of - After= and Requires= - dependency on sysinit.target, and a pair of - Before= and Conflicts= - dependencies on shutdown.target. These - dependencies ensure that the socket unit is started before normal - services at boot, and is stopped on shutdown. Only sockets - involved with early boot or late system shutdown should disable - DefaultDependencies= option. - + + Socket units automatically gain a + Before= dependency on + sockets.target. + + Socket units automatically gain a pair of + After= and Requires= + dependency on sysinit.target, and a pair of + Before= and Conflicts= + dependencies on shutdown.target. These + dependencies ensure that the socket unit is started before normal + services at boot, and is stopped on shutdown. Only sockets + involved with early boot or late system shutdown should disable + DefaultDependencies= option. + + diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 5a2ec492129..8f865fcb8ad 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -76,34 +76,38 @@ - Implicit Dependencies + Automatic Dependencies - The following dependencies are implicitly added: + + Implicit Dependencies - - All swap units automatically get the - BindsTo= and After= - dependencies on the device units or the mount units of the files - they are activated from. - + The following dependencies are implicitly added: - Additional implicit dependencies may be added as result of - execution and resource control parameters as documented in - systemd.exec5 - and - systemd.resource-control5. - + + All swap units automatically get the + BindsTo= and After= + dependencies on the device units or the mount units of the files + they are activated from. + - - Default Dependencies + Additional implicit dependencies may be added as result of + execution and resource control parameters as documented in + systemd.exec5 + and + systemd.resource-control5. + - The following dependencies are added unless DefaultDependencies=no is set: + + Default Dependencies - - Swap units automatically acquire a Conflicts= and a - Before= dependency on umount.target so that they are deactivated at - shutdown as well as a Before=swap.target dependency. - + The following dependencies are added unless DefaultDependencies=no is set: + + + Swap units automatically acquire a Conflicts= and a + Before= dependency on umount.target so that they are deactivated at + shutdown as well as a Before=swap.target dependency. + + diff --git a/man/systemd.target.xml b/man/systemd.target.xml index 3088a1cfdb3..a5b31ec26e7 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -69,30 +69,34 @@ - Implicit Dependencies + Automatic Dependencies - There are no implicit dependencies for target units. - + + Implicit Dependencies - - Default Dependencies + There are no implicit dependencies for target units. + - The following dependencies are added unless - DefaultDependencies=no is set: + + Default Dependencies - - Target units will automatically complement all - configured dependencies of type Wants= or - Requires= with dependencies of type - After= unless DefaultDependencies=no - is set in the specified units. Note that Wants= or - Requires= must be defined in the target unit itself — if - you for example define Wants=some.target in - some.service, the automatic ordering will not be added. + The following dependencies are added unless + DefaultDependencies=no is set: - Target units automatically gain Conflicts= - dependency against shutdown.target. - + + Target units will automatically complement all + configured dependencies of type Wants= or + Requires= with dependencies of type + After= unless DefaultDependencies=no + is set in the specified units. Note that Wants= or + Requires= must be defined in the target unit itself — if + you for example define Wants=some.target in + some.service, the automatic ordering will not be added. + + Target units automatically gain Conflicts= + dependency against shutdown.target. + + diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 3c8d92e2cd3..76a8dc4d8cd 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -82,23 +82,33 @@ - Default Dependencies + Automatic Dependencies - The following dependencies are added unless DefaultDependencies=no is set: + + Implicit Dependencies - - Timer units will automatically have dependencies of type Requires= and - After= on sysinit.target, a dependency of type Before= - on timers.target, as well as Conflicts= and Before= on - shutdown.target to ensure that they are stopped cleanly prior to system shutdown. Only timer - units involved with early boot or late system shutdown should disable the - DefaultDependencies= option. + There are no implicit dependencies for timer units. + - Timer units - with at least one OnCalendar= directive will have an additional After= - dependency on time-sync.target to avoid being started before the system clock has been - correctly set. - + + Default Dependencies + + The following dependencies are added unless DefaultDependencies=no is set: + + + Timer units will automatically have dependencies of type Requires= and + After= on sysinit.target, a dependency of type Before= + on timers.target, as well as Conflicts= and Before= on + shutdown.target to ensure that they are stopped cleanly prior to system shutdown. Only timer + units involved with early boot or late system shutdown should disable the + DefaultDependencies= option. + + Timer units + with at least one OnCalendar= directive will have an additional After= + dependency on time-sync.target to avoid being started before the system clock has been + correctly set. + + diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 9264dd1472b..1519ef3e6d2 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -268,40 +268,40 @@ - Implicit Dependencies + Automatic dependencies - A number of unit dependencies are implicitly established, - depending on unit type and unit configuration. These implicit - dependencies can make unit configuration file cleaner. For the - implicit dependencies in each unit type, please refer to - section "Implicit Dependencies" in respective man pages. + + Implicit Dependencies - For example, service units with Type=dbus - automatically acquire dependencies of type Requires= - and After= on dbus.socket. See - systemd.service5 - for details. - + A number of unit dependencies are implicitly established, depending on unit type and + unit configuration. These implicit dependencies can make unit configuration file cleaner. For + the implicit dependencies in each unit type, please refer to section "Implicit Dependencies" + in respective man pages. - - Default Dependencies + For example, service units with Type=dbus automatically acquire + dependencies of type Requires= and After= on + dbus.socket. See + systemd.service5 + for details. + - Default dependencies are similar to implicit dependencies, - but can be turned on and off by setting - DefaultDependencies= to yes - (the default) and no, while implicit dependencies - are always in effect. See section "Default Dependencies" in respective - man pages for the effect of enabling - DefaultDependencies= in each unit types. + + Default Dependencies - For example, target units will complement all configured - dependencies of type Wants= or - Requires= with dependencies of type - After= unless DefaultDependencies=no - is set in the specified units. See - systemd.target5 - for details. Note that this behavior can be turned off by setting - DefaultDependencies=no. + Default dependencies are similar to implicit dependencies, but can be turned on and off + by setting DefaultDependencies= to yes (the default) and + no, while implicit dependencies are always in effect. See section "Default + Dependencies" in respective man pages for the effect of enabling + DefaultDependencies= in each unit types. + + For example, target units will complement all configured dependencies of type + Wants= or Requires= with dependencies of type + After= unless DefaultDependencies=no is set in the + specified units. See + systemd.target5 + for details. Note that this behavior can be turned off by setting + DefaultDependencies=no. +