From 81eb21b9918bf581849d41b4ecbe85d55f88ab73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 28 Sep 2015 11:40:25 -0400 Subject: [PATCH 1/5] man: add link to functionfs docs Also reword some ungainly grammar constructs. --- man/systemd.service.xml | 15 +++++++++------ man/systemd.socket.xml | 14 +++++++++----- man/timedatectl.xml | 2 +- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 642d95a0295..eac7504feed 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -905,12 +905,15 @@ USBFunctionDescriptors= - Configure the location of file containing - FunctionFS descriptors. This is is used only when socket with - ListenUSBFunction line want to activate this service. Content of - this file is writen to ep0 file after it is opened. This is required - for socket activation using ListenUSBFunction - (i.e. for passing all ffs endpoints to service). + Configure the location of the file containing + functionfs + descriptors. This is is used only when a socket with + ListenUSBFunction configured wants to + activate this service. Content of this file is writen to + ep0 file after it is opened. This is + required for socket activation using + ListenUSBFunction (i.e. for passing all + functionfs endpoints to the service). diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 7f884aa1be3..e63a33a47be 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -262,13 +262,17 @@ ListenUSBFunction= - Specifies a functionfs endpoint location - to listen on. This expects an absolute file system path as + Specifies a + functionfs + endpoint location to + listen on. This expects an absolute file system path as the argument. Behavior otherwise is very similar to the ListenFIFO= directive above. Use this to - open functionfs endpoint ep0. When using this option, activated - service has to have USBFunctionDescriptors - and USBFunctionStrings options set. + open functionfs endpoint ep0. When using + this option, activated service has to have the + USBFunctionDescriptors and + USBFunctionStrings options set. + diff --git a/man/timedatectl.xml b/man/timedatectl.xml index 9a86c4126a9..c439bc56ede 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -178,7 +178,7 @@ protected by a different access policy. Note that even if time synchronization is turned off - with this command another, unrelated system service might + with this command, another unrelated system service might still synchronize the clock with the network. Also note that strictly speaking systemd-timesyncd.service does more than From 22065311405b289547dd910bc76f5002a4600aa6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 28 Sep 2015 11:42:30 -0400 Subject: [PATCH 2/5] man: use "=" when referring to configuration file settings This convention is almost universal in systemd man pages, and makes it easier to visually parse the docs. Also fix some markup along the way. --- man/machine-id.xml | 2 +- man/systemd.service.xml | 10 +++++----- man/systemd.socket.xml | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/man/machine-id.xml b/man/machine-id.xml index 8ce9c46ff12..db72c2a01ca 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -119,7 +119,7 @@ id[8] = (id[8] & 0x3F) | 0x80; /etc/machine-id originates in the /var/lib/dbus/machine-id file introduced by D-Bus. In fact, this latter file might be a symlink to - /etc/machine-id. + /etc/machine-id. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index eac7504feed..eeb98198abf 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -287,7 +287,7 @@ below (see section "Command Lines" below). - When Type is not + When Type= is not , only one command may and must be given. When Type=oneshot is used, zero or more commands may be specified. This can be specified by @@ -421,7 +421,7 @@ ExecStop= defined, or where the service exited unexpectedly. This argument takes multiple command lines, following the same scheme as described for - ExecStart. Use of these settings is + ExecStart=. Use of these settings is optional. Specifier and environment variable substitution is supported. @@ -486,7 +486,7 @@ "keep-alive ping"). If the time between two such calls is larger than the configured time, then the service is placed in a failed state and it will be terminated with - SIGABRT. By setting + SIGABRT. By setting Restart= to or , the service will be automatically restarted. The time configured here will be passed to the @@ -908,11 +908,11 @@ Configure the location of the file containing functionfs descriptors. This is is used only when a socket with - ListenUSBFunction configured wants to + ListenUSBFunction= configured wants to activate this service. Content of this file is writen to ep0 file after it is opened. This is required for socket activation using - ListenUSBFunction (i.e. for passing all + ListenUSBFunction= (i.e. for passing all functionfs endpoints to the service). diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index e63a33a47be..bb75b69cea4 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -270,8 +270,8 @@ ListenFIFO= directive above. Use this to open functionfs endpoint ep0. When using this option, activated service has to have the - USBFunctionDescriptors and - USBFunctionStrings options set. + USBFunctionDescriptors= and + USBFunctionStrings= options set. From 3fd96cb3c0fc484cf9c9c0de014ffead9e145e96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 30 Sep 2015 10:41:41 -0400 Subject: [PATCH 3/5] man: add link to kernel docs for net_cls --- man/systemd.unit.xml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 015deab4bb1..8985b6b9406 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1055,8 +1055,11 @@ auto (for dynamic allocation). Network traffic of all processes inside the unit will have the network class ID assigned by the kernel. Also see - systemd.resource-control5 - . + the kernel docs for + net_cls controller + and + systemd.resource-control5. + From 9f4092e2703e5efc6e62ba3e7b0d56e86aa1e953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 30 Sep 2015 11:14:32 -0400 Subject: [PATCH 4/5] man: update description of exit.target exit.target is now used for both system and user sessions, so remove "on user service manager exit". Also reword that paragraph: services will be killed before the manager exits, even if they do not conflict with shutdown target, but we recommend that they conflict with shutdown target so that systemd schedules them to be stopped immediately when starting to exit. In the first paragraph, containers should be mentioned last, and the more general systems first. --- man/systemd.special.xml | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 6e0dff9b475..78bad4d814e 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -215,20 +215,19 @@ exit.target A special service unit for shutting down the system or - user service manager. It also works in containers and is - equivalent to poweroff.target on - non-container systems. + user service manager. It is equivalent to + poweroff.target on non-container + systems, and also works in containers. - Applications wanting to terminate the user service - manager should start this unit. If systemd receives + systemd will start this unit when it receives a + request to shut down over D-Bus or a SIGTERM or SIGINT - when running as user service daemon, it will start this - unit. + signal when running as user service daemon. - Normally, this pulls in + Normally, this (indirectly) pulls in shutdown.target which in turn should be - conflicted by all units that want to be shut down on user - service manager exit. + conflicted by all units that want to be scheduled for + shutdown when the service manager starts to exit. From 6fd5517b11d2c258b3c09baf571bae71b9ac98a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 30 Sep 2015 11:48:33 -0400 Subject: [PATCH 5/5] NEWS: typos --- NEWS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/NEWS b/NEWS index 03dc5ba2e38..e56a922d2b3 100644 --- a/NEWS +++ b/NEWS @@ -17,7 +17,7 @@ CHANGES WITH 227: It allows accounting the number of tasks in a cgroup and enforcing limits on it. This adds two new setting TasksAccounting= and TasksMax= to each unit, as well as a - gloabl option DefaultTasksAccounting=. + global option DefaultTasksAccounting=. * Support for the "net_cls" cgroup controller has been added. It allows assigning a net class ID to each task in the cgroup, @@ -27,7 +27,7 @@ CHANGES WITH 227: sockets. This adds a new config directive called NetClass= to CGroup - enabled units. Allowed values are positive numbers for fix + enabled units. Allowed values are positive numbers for fixed assignments and "auto" for picking a free value automatically.