From: Jan Engelhardt Date: Thu, 26 Dec 2013 01:47:44 +0000 (+0100) Subject: man: improvements to comma placement X-Git-Tag: v209~637 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=b040723ea412209e0edf54647fa5aa4287411507 man: improvements to comma placement This is a recurring submission and includes corrections to: comma placement. --- diff --git a/man/halt.xml b/man/halt.xml index 2a13d3c63..f54a8648a 100644 --- a/man/halt.xml +++ b/man/halt.xml @@ -148,7 +148,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index 29914b8c8..4bc05f52c 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -255,7 +255,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/journalctl.xml b/man/journalctl.xml index 2de72523c..6a972109c 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -691,7 +691,7 @@ matching GLOB instead of the default runtime and system journal paths. May be specified - multiple times, in which case, files will + multiple times, in which case files will be suitably interleaved. diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 74fe435ac..ed85debd7 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -83,7 +83,7 @@ sd_booted3, sd_is_fifo3 for more information about the functions - implemented. In addition to these functions a couple + implemented. In addition to these functions, a couple of logging prefixes are defined as macros: #define SD_EMERG "<0>" /* system is unusable */ @@ -135,7 +135,7 @@ implementation. See the respective function man pages for details. - In addition, for details about the algorithms + In addition, for details about the algorithms, check the liberally licensed reference implementation sources: diff --git a/man/sd-readahead.xml b/man/sd-readahead.xml index f8a0a0b55..bcc46b24d 100644 --- a/man/sd-readahead.xml +++ b/man/sd-readahead.xml @@ -83,7 +83,7 @@ reference implementation. See the respective function man pages for details. - In addition, for details about the algorithms + In addition, for details about the algorithms, check the liberally licensed reference implementation sources: diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 6f8cc95ca..1e38d2abd 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -106,7 +106,7 @@ file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference - implementation see + implementation, see sd-daemon3. If the reference implementation is used as diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml index db344bf1b..0e3c4ba72 100644 --- a/man/sd_bus_message_get_cookie.xml +++ b/man/sd_bus_message_get_cookie.xml @@ -78,7 +78,7 @@ sd_bus_message_get_reply_cookie() returns the transaction cookie of the message the specified message is a response to. When a reply - message is generated for a method call message its + message is generated for a method call message, its cookie is copied over into this field. Note that while every message that is transferred is identified by a cookie, only response messages carry a reply cookie @@ -96,7 +96,7 @@ integer. On failure, these calls return a negative errno-style error code. - On success the cookie/reply cookie is returned + On success, the cookie/reply cookie is returned in the specified 64bit unsigned integer variable. diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 7fae7becf..c84b0b62f 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -87,7 +87,7 @@ SD_BUS_NAME_REPLACE_EXISTING flag set. If SD_BUS_NAME_ALLOW_REPLACEMENT - is not set on the original request + is not set on the original request, such a request by other peers will be denied. @@ -125,10 +125,10 @@ errno-style error code. If SD_BUS_NAME_QUEUE is - specified sd_bus_request_name() + specified, sd_bus_request_name() will return 0 when the name is already taken by another peer and the client has been added to the - queue for the name. In that case the caller can + queue for the name. In that case, the caller can subscribe to NameOwnerChanged signals to be notified when the name is successfully acquired. sd_bus_request_name() diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index 1e55af3bd..f0e7655d4 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -107,7 +107,7 @@ Return Value - On success sd_get_seats(), + On success, sd_get_seats(), sd_get_sessions(), sd_get_uids() and sd_get_machine_names() return the diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 5e79453ce..4bb2236fc 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -214,7 +214,7 @@ file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference - implementation see + implementation, see sd-daemon3. These functions continue to work as described, diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index aaabdbf3e..6a9e08218 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -155,7 +155,7 @@ file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference - implementation see + implementation, see sd-daemon3. If the reference implementation is used as diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index f439d3e7b..14ff241d8 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -198,13 +198,13 @@ else { Return Value - On success + On success, sd_login_monitor_new(), sd_login_monitor_flush() and sd_login_monitor_get_timeout() - return 0 or a positive integer. On success + return 0 or a positive integer. On success, sd_login_monitor_get_fd() returns - a Unix file descriptor. On success + a Unix file descriptor. On success, sd_login_monitor_get_events() returns a combination of POLLIN, POLLOUT and suchlike. On failure, diff --git a/man/sd_notify.xml b/man/sd_notify.xml index cd4a437f3..d21820f67 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -245,7 +245,7 @@ libsystemd-daemon pkg-config1 file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For - more details about the reference implementation see + more details about the reference implementation, see sd-daemon3. If the reference implementation is used as diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml index bb01bcfd8..98272997c 100644 --- a/man/sd_readahead.xml +++ b/man/sd_readahead.xml @@ -139,7 +139,7 @@ sd-readahead.h files. It is recommended that applications consuming this API copy the implementation into their source tree. For more - details about the reference implementation see + details about the reference implementation, see sd-readahead3 If -DDISABLE_SYSTEMD is set during compilation, diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 23d582da9..c64ba13c3 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -143,9 +143,9 @@ Return Value - On success + On success, sd_seat_get_active() - returns 0 or a positive integer. On success + returns 0 or a positive integer. On success, sd_seat_get_sessions() returns the number of entries in the session identifier array. If the test succeeds, diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index d1f1a349d..bff6b04ea 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -270,7 +270,7 @@ If the test succeeds, sd_session_is_active() and sd_session_is_remote() return a - positive integer, if it fails 0. On success + positive integer; if it fails, 0. On success, sd_session_get_state(), sd_session_get_uid(), sd_session_get_seat(), diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index 0faa7651e..30b254c80 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -152,11 +152,11 @@ Return Value - On success + On success, sd_uid_get_state() returns 0 or a positive integer. If the test succeeds, sd_uid_is_on_seat() returns a - positive integer, if it fails + positive integer; if it fails, 0. sd_uid_get_sessions() and sd_uid_get_seats() return the number of entries in the returned arrays. On failure, diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index 5b0d7e21c..cad92df7a 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -80,7 +80,7 @@ inherited by child processes. If the usec parameter is - non-NULL sd_watchdog_enabled() + non-NULL, sd_watchdog_enabled() will return the timeout in µs for the watchdog logic. The service manager will usually terminate a service when it did not get a notification message @@ -94,7 +94,7 @@ WATCHDOG=1. To enable service supervision with the watchdog - logic use WatchdogSec= in service + logic, use WatchdogSec= in service files. See systemd.service5 for details. @@ -107,7 +107,7 @@ errno-style error code. If the service manager expects watchdog keep-alive notification messages to be sent, > 0 is returned, otherwise 0 is returned. Only if - the return value is > 0 the + the return value is > 0, the usec parameter is valid after the call. @@ -129,10 +129,10 @@ variable. The call will ignore these variables if $WATCHDOG_PID does containe the PID of the current process, under the assumption that in - that case the variables were set for a different + that case, the variables were set for a different process further up the process tree. - For details about the algorithm check the + For details about the algorithm, check the liberally licensed reference implementation sources: and sd-daemon3. If the reference implementation is used as diff --git a/man/shutdown.xml b/man/shutdown.xml index 795fb6632..27e7e87b6 100644 --- a/man/shutdown.xml +++ b/man/shutdown.xml @@ -164,7 +164,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemctl.xml b/man/systemctl.xml index 6f51135c8..7c9ffc81a 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -238,7 +238,7 @@ along with systemd; If not, see . applications. ignore-requirements is similar to - ignore-dependencies but only causes the + ignore-dependencies, but only causes the requirement dependencies to be ignored, the ordering dependencies will still be honoured. @@ -1383,7 +1383,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service Parameter Syntax - For unit commands the specified + For unit commands, the specified NAME should be the full name of the unit, or an abbreviated name which is automatically extended with the .service suffix. @@ -1395,7 +1395,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service # systemctl status dev-sda.device # systemctl status home.mount - For unit file commands the + For unit file commands, the specified NAME should be the full name of the unit file, or the absolute path to the unit file. # systemctl link /path/to/foo.service diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 1898ca6fb..cbf59e0a1 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -300,7 +300,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml index 8af328dcf..79902cbd9 100644 --- a/man/systemd-ask-password.xml +++ b/man/systemd-ask-password.xml @@ -167,7 +167,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index ffb1dfd50..ba7a2cf0c 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -158,7 +158,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index d4520e64d..955e0da37 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -145,7 +145,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index 01a0ae216..38bddf183 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -264,7 +264,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml index 9ccb67d12..67f75d1c5 100644 --- a/man/systemd-coredumpctl.xml +++ b/man/systemd-coredumpctl.xml @@ -200,7 +200,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. Not finding any matching coredumps is treated as failure. diff --git a/man/systemd-delta.xml b/man/systemd-delta.xml index 4d3ab7804..ebaa3492f 100644 --- a/man/systemd-delta.xml +++ b/man/systemd-delta.xml @@ -223,7 +223,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml index bc38d551c..7b3aa7e9a 100644 --- a/man/systemd-machine-id-setup.xml +++ b/man/systemd-machine-id-setup.xml @@ -116,7 +116,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index a76934649..e14977d05 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -172,7 +172,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index 9b8932c63..3d11c491d 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -183,7 +183,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml index 31a18ba4b..cb5fb43d9 100644 --- a/man/systemd-tty-ask-password-agent.xml +++ b/man/systemd-tty-ask-password-agent.xml @@ -148,7 +148,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 1bbd32248..fa7074aaf 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -75,7 +75,7 @@ udev tag (by default all block and network devices, and a few others). This may be used to define dependencies between devices and other units. To tag a - udev device use TAG+="systemd" in + udev device, use TAG+="systemd" in the udev rules file, see udev7 for details. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 207592dda..277849764 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -847,7 +847,7 @@ processes and mounts private /tmp and /var/tmp - directories inside it, that are not + directories inside it that are not shared by processes outside of the namespace. This is useful to secure access to temporary files of the diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index bd50f352e..b181949b1 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -94,7 +94,7 @@ in a unit file home-lennart.mount. For details about the escaping logic used to convert a file system - path to a unit name see + path to a unit name, see systemd.unit5. Optionally, a mount unit may be accompanied by diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 94e72df9b..8e6c20550 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -441,7 +441,7 @@ one and two two, respectively. Since two commands are - specified + specified, Type=oneshot must be used. diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 863a029fe..76bb5cdcf 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -996,7 +996,7 @@ smartcard.target, sound.target. - In addition the following special unit is + In addition, the following special unit is understood only when systemd runs as service instance: diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 041123285..492309e53 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -85,7 +85,7 @@ /dev/sda5 must be configured in a unit file dev-sda5.swap. For details about the escaping logic used to convert a - file system path to a unit name see + file system path to a unit name, see systemd.unit5. All swap units automatically get the appropriate diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 484287ccf..7143f9f93 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -141,7 +141,7 @@ also include time units. Example: "OnBootSec=5h 30min" means 5 hours and 30 minutes after boot-up. For details - about the syntax of time spans see + about the syntax of time spans, see systemd.unit5. If a timer configured with @@ -182,7 +182,7 @@ event expressions. See systemd.time7 for more information on the syntax of - calendar event expressions. Otherwise + calendar event expressions. Otherwise, the semantics are similar to OnActiveSec= and related settings. @@ -211,7 +211,7 @@ OnUnitInactiveSec= and ending the time configured with AccuracySec= - later. Within this time window the + later. Within this time window, the expiry time will be placed at a host-specific, randomized but stable position, that is synchronized between @@ -220,7 +220,7 @@ in networked installations, as well as optimizing power consumption to suppress unnecessary CPU wake-ups. To - get best accuracy set this option to + get best accuracy, set this option to 1us. Note that the timer is still subject to the timer slack configured via @@ -229,7 +229,7 @@ setting. See prctl2 for details. To optimize power - consumption make sure to set this + consumption, make sure to set this value as high as possible and as low as necessary. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 54d5590c8..024457036 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -403,7 +403,7 @@ what the unit's purpose is, followed by how it is configured, followed by any other related documentation. This - option may be specified more than once + option may be specified more than once, in which case the specified list of URIs is merged. If the empty string is assigned to this option, the list is @@ -492,7 +492,7 @@ Requires= and RequiresOverridable=, respectively. However, if the units - listed here are not started already + listed here are not started already, they will not be started and the transaction will fail immediately. @@ -506,7 +506,7 @@ listed in this option will be started if the configuring unit is. However, if the listed units fail to start - or cannot be added to the transaction + or cannot be added to the transaction, this has no impact on the validity of the transaction as a whole. This is the recommended way to hook start-up @@ -519,7 +519,7 @@ symlinks to a .wants/ directory accompanying the unit file. For - details see above. + details, see above. @@ -528,7 +528,7 @@ Configures requirement dependencies, very similar in style to Requires=, however - in addition to this behavior it also + in addition to this behavior, it also declares that this unit is stopped when any of the units listed suddenly disappears. Units can suddenly, @@ -577,9 +577,9 @@ be modified to be fixed (in case one or both jobs are not a required part of the transaction). In the latter - case the job that is not the required + case, the job that is not the required will be removed, or in case both are - not required the unit that conflicts + not required, the unit that conflicts will be started and the unit that is conflicted is stopped. @@ -606,7 +606,7 @@ a common pattern to include a unit name in both the After= and - Requires= option in + Requires= option, in which case the unit listed will be started before the unit that is configured with these options. This @@ -686,13 +686,13 @@ directives (see systemd.exec5 for details). If a unit that has this - setting set is started its processes + setting set is started, its processes will see the same /tmp, /tmp/var and network namespace as one listed unit that is started. If multiple listed - units are already started it is not + units are already started, it is not defined which namespace is joined. Note that this setting only has an effect if @@ -1270,7 +1270,7 @@ %p Prefix name - For instantiated units this refers to the string before the @ character of the unit name. For non-instantiated units this refers to the name of the unit with the type suffix removed. + For instantiated units, this refers to the string before the @ character of the unit name. For non-instantiated units, this refers to the name of the unit with the type suffix removed. %P @@ -1325,12 +1325,12 @@ %h User home directory - This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. + This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U, this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. %s User shell - This is the shell of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. + This is the shell of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to %U, this specifier is not available for units run by the systemd system instance, unless the configured user is the root user. %m diff --git a/man/systemd.xml b/man/systemd.xml index 10ce375da..acba820fd 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -480,7 +480,7 @@ /proc. For more information about the concepts and - ideas behind systemd please refer to the Original Design Document. diff --git a/man/telinit.xml b/man/telinit.xml index bb8093914..b20a60a4c 100644 --- a/man/telinit.xml +++ b/man/telinit.xml @@ -171,7 +171,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. diff --git a/man/timedatectl.xml b/man/timedatectl.xml index afcb716e4..beda30485 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -223,7 +223,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise.