From b514d6c9dcc7c0d7353f975ecfb94f2197c73cf1 Mon Sep 17 00:00:00 2001 From: Sven Eden Date: Thu, 19 Jan 2017 13:04:18 +0100 Subject: [PATCH] Fix man page building to be less systemd and more elogind. --- Makefile-man.am | 11 ++- Makefile.am | 2 +- man/loginctl.xml | 6 +- man/{elogind.conf.xml => logind.conf.xml} | 14 +-- man/logind.xml | 18 ++-- man/pam_elogind.xml | 10 +-- man/sd_is_fifo.xml | 2 +- man/sd_notify.xml | 8 +- man/sd_watchdog_enabled.xml | 4 +- src/libelogind/.gitignore | 1 - src/login/logind-session.c | 2 +- src/login/logind.c | 4 +- tools/make-directive-index.py | 101 +++------------------- tools/make-man-index.py | 22 ++--- 14 files changed, 69 insertions(+), 136 deletions(-) rename man/{elogind.conf.xml => logind.conf.xml} (96%) diff --git a/Makefile-man.am b/Makefile-man.am index f862a5497..d862b3bba 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -8,8 +8,9 @@ # attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT" # to element. MANPAGES += \ - man/elogind.conf.5 \ man/loginctl.1 \ + man/logind.conf.5 \ + man/logind.service.8 \ man/sd_id128_get_machine.3 \ man/sd_id128_randomize.3 \ man/sd_id128_to_string.3 \ @@ -18,6 +19,7 @@ MANPAGES += \ man/sd_notify.3 \ man/sd_watchdog_enabled.3 MANPAGES_ALIAS += \ + man/logind.8 \ man/sd_id128_from_string.3 \ man/sd_id128_get_boot.3 \ man/sd_is_mq.3 \ @@ -30,6 +32,7 @@ MANPAGES_ALIAS += \ man/sd_pid_notify.3 \ man/sd_pid_notify_with_fds.3 \ man/sd_pid_notifyf.3 +man/logind.8: man/logind.service.8 man/sd_id128_from_string.3: man/sd_id128_to_string.3 man/sd_id128_get_boot.3: man/sd_id128_get_machine.3 man/sd_is_mq.3: man/sd_is_fifo.3 @@ -42,6 +45,9 @@ man/sd_notifyf.3: man/sd_notify.3 man/sd_pid_notify.3: man/sd_notify.3 man/sd_pid_notify_with_fds.3: man/sd_notify.3 man/sd_pid_notifyf.3: man/sd_notify.3 +man/logind.html: man/logind.service.html + $(html-alias) + man/sd_id128_from_string.html: man/sd_id128_to_string.html $(html-alias) @@ -191,10 +197,11 @@ endif # Really, do not edit this file. EXTRA_DIST += \ - man/elogind.conf.xml \ man/less-variables.xml \ man/libelogind-pkgconfig.xml \ man/loginctl.xml \ + man/logind.conf.xml \ + man/logind.xml \ man/pam_elogind.xml \ man/sd_get_seats.xml \ man/sd_id128_get_machine.xml \ diff --git a/Makefile.am b/Makefile.am index bbc633079..6a19521b0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -276,7 +276,7 @@ endif endif EXTRA_DIST += \ - $(filter-out man/systemd.directives.xml,$(XML_FILES)) \ + $(filter-out man/elogind.directives.xml,$(XML_FILES)) \ $(HTML_FILES) \ $(HTML_ALIAS) \ $(man_MANS) \ diff --git a/man/loginctl.xml b/man/loginctl.xml index 8a1ddb618..45b0cf312 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -63,7 +63,7 @@ control the state of the elogind1 login manager - elogind-logind.service8. + logind.service8. @@ -406,8 +406,8 @@ elogind1, systemctl1, - elogind-logind.service8, - elogind.conf5 + logind.service8, + logind.conf5 diff --git a/man/elogind.conf.xml b/man/logind.conf.xml similarity index 96% rename from man/elogind.conf.xml rename to man/logind.conf.xml index ddb01ec4a..1f7cfc996 100644 --- a/man/elogind.conf.xml +++ b/man/logind.conf.xml @@ -21,9 +21,9 @@ along with elogind; If not, see . --> - + - elogind.conf + logind.conf elogind @@ -37,17 +37,17 @@ - elogind.conf + logind.conf 5 - elogind.conf + logind.conf Login manager configuration files - /etc/elogind/elogind.conf + /etc/elogind/logind.conf @@ -55,7 +55,7 @@ These files configure various parameters of the elogind login manager, - elogind-logind.service8. + logind.service8. @@ -296,7 +296,7 @@ See Also elogind1, - elogind-logind.service8, + logind.service8, loginctl1, elogind-system.conf5 diff --git a/man/logind.xml b/man/logind.xml index 5733e42cd..7afacbf34 100644 --- a/man/logind.xml +++ b/man/logind.xml @@ -21,10 +21,10 @@ along with systemd; If not, see . --> - + - systemd-logind.service + logind.service systemd @@ -38,25 +38,25 @@ - systemd-logind.service + logind.service 8 - systemd-logind.service - systemd-logind + logind.service + logind Login manager - systemd-logind.service - /usr/lib/systemd/systemd-logind + logind.service + /usr/lib/systemd/logind Description - systemd-logind is a system service that + logind is a system service that manages user logins. It is responsible for: @@ -100,7 +100,7 @@ See the logind D-Bus API Documentation for information about the - APIs systemd-logind provides. + APIs logind provides. For more information on the inhibition logic see the Inhibitor diff --git a/man/pam_elogind.xml b/man/pam_elogind.xml index 700f0cc88..02c11a1e3 100644 --- a/man/pam_elogind.xml +++ b/man/pam_elogind.xml @@ -56,7 +56,7 @@ pam_elogind registers user sessions with the elogind login manager - elogind-logind.service8, + logind.service8, and hence the elogind control group hierarchy. On login, this module ensures the following: @@ -88,7 +88,7 @@ If enabled in - elogind.conf + logind.conf 5, all processes of the session are terminated. If the last concurrent session of a user ends, the user's elogind instance will be terminated too, and so @@ -280,8 +280,8 @@ session required pam_elogind.so See Also elogind1, - elogind-logind.service8, - elogind.conf5, + logind.service8, + logind.conf5, loginctl1, pam.conf5, pam.d5, @@ -289,7 +289,7 @@ session required pam_elogind.so pam_loginuid8, elogind.scope5, elogind.slice5, - elogind.service5 + logind.service5 diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 64f23cb6f..83c204d0c 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -192,7 +192,7 @@ elogind1, sd-daemon3, sd_listen_fds3, - elogind.service5, + logind.service5, elogind.socket5 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 41c3f3fa7..c52ef533b 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -194,7 +194,7 @@ watchdog timestamp. This is the keep-alive ping that services need to issue in regular intervals if WatchdogSec= is enabled for it. See - elogind.service5 + logind.service5 for information how to enable this functionality and sd_watchdog_enabled3 for the details of how the service can check whether the @@ -219,7 +219,7 @@ manager will accept messages for a service only if FileDescriptorStoreMax= is set to non-zero for it (defaults to zero). See - elogind.service5 + logind.service5 for details. Multiple arrays of file descriptors may be sent in separate messages, in which case the arrays are combined. Note that the service manager removes duplicate file @@ -238,7 +238,7 @@ Note that elogind will accept status data sent from a service only if the NotifyAccess= option is correctly set in the service definition file. See - elogind.service5 + logind.service5 for details. sd_notifyf() is similar to @@ -368,7 +368,7 @@ elogind1, sd-daemon3, daemon7, - elogind.service5, + logind.service5, sd_watchdog_enabled3 diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index e588b0401..efa8fbf3f 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -96,7 +96,7 @@ To enable service supervision with the watchdog logic, use WatchdogSec= in service files. See - elogind.service5 + logind.service5 for details. @@ -167,7 +167,7 @@ elogind1, sd-daemon3, daemon7, - elogind.service5, + logind.service5, sd_notify3 diff --git a/src/libelogind/.gitignore b/src/libelogind/.gitignore index d8998b7d0..17111f7a3 100644 --- a/src/libelogind/.gitignore +++ b/src/libelogind/.gitignore @@ -1,2 +1 @@ -/libelogind.sym /libelogind.pc diff --git a/src/login/logind-session.c b/src/login/logind-session.c index 92a6027a7..a277cda48 100644 --- a/src/login/logind-session.c +++ b/src/login/logind-session.c @@ -519,7 +519,7 @@ static int session_start_scope(Session *s) { if (!scope) return log_oom(); - r = manager_start_scope(s->manager, scope, s->leader, s->user->slice, description, "systemd-logind.service", "systemd-user-sessions.service", &error, &job); + r = manager_start_scope(s->manager, scope, s->leader, s->user->slice, description, "logind.service", "systemd-user-sessions.service", &error, &job); if (r < 0) { log_error("Failed to start session scope %s: %s %s", scope, bus_error_message(&error, r), error.name); diff --git a/src/login/logind.c b/src/login/logind.c index 4bbbdf554..792a04dc0 100644 --- a/src/login/logind.c +++ b/src/login/logind.c @@ -1150,7 +1150,7 @@ int main(int argc, char *argv[]) { goto finish; } - log_debug("systemd-logind running as pid "PID_FMT, getpid()); + log_debug("logind running as pid "PID_FMT, getpid()); sd_notify(false, "READY=1\n" @@ -1158,7 +1158,7 @@ int main(int argc, char *argv[]) { r = manager_run(m); - log_debug("systemd-logind stopped as pid "PID_FMT, getpid()); + log_debug("logind stopped as pid "PID_FMT, getpid()); finish: sd_notify(false, diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 17b1325bb..183eca3bb 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -1,21 +1,21 @@ # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */ # -# This file is part of systemd. +# This file is part of elogind. # # Copyright 2012-2013 Zbigniew Jędrzejewski-Szmek # -# systemd is free software; you can redistribute it and/or modify it +# elogind is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation; either version 2.1 of the License, or # (at your option) any later version. # -# systemd is distributed in the hope that it will be useful, but +# elogind is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License -# along with systemd; If not, see . +# along with elogind; If not, see . import sys import collections @@ -24,11 +24,11 @@ from xml_helper import * from copy import deepcopy TEMPLATE = '''\ - + - systemd.directives - systemd + elogind.directives + elogind @@ -41,69 +41,15 @@ TEMPLATE = '''\ - systemd.directives + elogind.directives 7 - systemd.directives + elogind.directives Index of configuration directives - - Unit directives - - Directives for configuring units, used in unit - files. - - - - - - Options on the kernel command line - - Kernel boot options for configuring the behaviour of the - systemd process. - - - - - - Environment variables - - Environment variables understood by the systemd - manager and other programs. - - - - - - UDEV directives - - Directives for configuring systemd units through the - udev database. - - - - - - Network directives - - Directives for configuring network links through the - net-setup-link udev builtin and networks through - systemd-networkd. - - - - - - Journal fields - - Fields in the journal events with a well known meaning. - - - - PAM configuration directives @@ -113,38 +59,19 @@ TEMPLATE = '''\ - <filename>/etc/crypttab</filename> and - <filename>/etc/fstab</filename> options - - Options which influence mounted filesystems and - encrypted volumes. - - - - - - System manager directives - - Directives for configuring the behaviour of the - systemd process. - - - - - - bootchart.conf directives + elogind manager directives Directives for configuring the behaviour of the - systemd-bootchart process. + elogind process. - + command line options Command-line options accepted by programs in the - systemd suite. + elogind suite. @@ -152,7 +79,7 @@ TEMPLATE = '''\ Constants - Various constant used and/or defined by systemd. + Various constant used and/or defined by elogind. diff --git a/tools/make-man-index.py b/tools/make-man-index.py index 74a47b821..396188212 100755 --- a/tools/make-man-index.py +++ b/tools/make-man-index.py @@ -1,22 +1,22 @@ # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */ # -# This file is part of systemd. +# This file is part of elogind. # # Copyright 2012 Lennart Poettering # Copyright 2013 Zbigniew Jędrzejewski-Szmek # -# systemd is free software; you can redistribute it and/or modify it +# elogind is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation; either version 2.1 of the License, or # (at your option) any later version. # -# systemd is distributed in the hope that it will be useful, but +# elogind is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License -# along with systemd; If not, see . +# along with elogind; If not, see . import collections import sys @@ -26,11 +26,11 @@ from xml_helper import * MDASH = ' — ' if sys.version_info.major >= 3 else ' -- ' TEMPLATE = '''\ - + - systemd.index - systemd + elogind.index + elogind @@ -43,13 +43,13 @@ TEMPLATE = '''\ - systemd.index + elogind.index 7 - systemd.index - List all manpages from the systemd project + elogind.index + List all manpages from the elogind project ''' @@ -58,7 +58,7 @@ SUMMARY = '''\ See Also - systemd.directives7 + elogind.directives7 -- 2.30.2