From 17bb3520f3e976c9e1cec61c330b1e37449b7832 Mon Sep 17 00:00:00 2001 From: Jan Engelhardt Date: Thu, 26 Dec 2013 02:47:44 +0100 Subject: [PATCH] man: improvements to comma placement This is a recurring submission and includes corrections to: comma placement. Conflicts: man/sd_bus_message_get_cookie.xml man/sd_bus_request_name.xml man/sd_session_is_active.xml man/sd_watchdog_enabled.xml man/systemctl.xml man/systemd.exec.xml man/systemd.timer.xml man/systemd.unit.xml --- man/halt.xml | 2 +- man/hostnamectl.xml | 2 +- man/sd-daemon.xml | 4 ++-- man/sd-readahead.xml | 2 +- man/sd_booted.xml | 2 +- man/sd_get_seats.xml | 2 +- man/sd_is_fifo.xml | 2 +- man/sd_listen_fds.xml | 2 +- man/sd_login_monitor_new.xml | 6 +++--- man/sd_notify.xml | 2 +- man/sd_readahead.xml | 2 +- man/sd_seat_get_active.xml | 4 ++-- man/sd_uid_get_state.xml | 4 ++-- man/shutdown.xml | 2 +- man/systemd-analyze.xml | 2 +- man/systemd-ask-password.xml | 2 +- man/systemd-cat.xml | 2 +- man/systemd-cgls.xml | 2 +- man/systemd-cgtop.xml | 2 +- man/systemd-coredumpctl.xml | 2 +- man/systemd-delta.xml | 2 +- man/systemd-machine-id-setup.xml | 2 +- man/systemd-notify.xml | 2 +- man/systemd-tmpfiles.xml | 2 +- man/systemd-tty-ask-password-agent.xml | 2 +- man/systemd.device.xml | 2 +- man/systemd.mount.xml | 2 +- man/systemd.service.xml | 2 +- man/systemd.special.xml | 2 +- man/systemd.swap.xml | 2 +- man/systemd.xml | 2 +- man/telinit.xml | 2 +- man/timedatectl.xml | 2 +- 33 files changed, 38 insertions(+), 38 deletions(-) diff --git a/man/halt.xml b/man/halt.xml index 2a13d3c..f54a864 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 b39fb55..a0776f5 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/sd-daemon.xml b/man/sd-daemon.xml index 84c1afa..b48eac9 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 f8a0a0b..bcc46b2 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 6f8cc95..1e38d2a 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_get_seats.xml b/man/sd_get_seats.xml index 1e55af3..f0e7655 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 5e79453..4bb2236 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 aaabdbf..6a9e082 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 f439d3e..14ff241 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 e078140..aae27a8 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -241,7 +241,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 bb01bcf..9827299 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 23d582d..c64ba13 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_uid_get_state.xml b/man/sd_uid_get_state.xml index 0faa765..30b254c 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/shutdown.xml b/man/shutdown.xml index 795fb66..27e7e87 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/systemd-analyze.xml b/man/systemd-analyze.xml index aefbfc8..b7753f9 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -270,7 +270,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 8af328d..79902cb 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 ffb1dfd..ba7a2cf 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 432706b..152b883 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 7faedfb..0e1f7c5 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 9ccb67d..67f75d1 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 4d3ab78..ebaa349 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 bc38d55..7b3aa7e 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 a769346..e14977d 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 495247e..c678031 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -178,7 +178,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 31a18ba..cb5fb43 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 002b647..586473c 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.mount.xml b/man/systemd.mount.xml index df5a79e..6f9f70c 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 80a935d..e869f95 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 863a029..76bb5cd 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 13f6c84..5e8b25f 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.xml b/man/systemd.xml index 85c06d3..23a0c26 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -494,7 +494,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 bb80939..b20a60a 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 be0ad3f..f4975ce 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -222,7 +222,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise.