man: generate configured paths in manpages

System Internals / systemd - Filipe Brandenburger [google.com] - 28 May 2015 12:28 UTC

In particular, use /lib/systemd instead of /usr/lib/systemd in distributions like Debian which still have not adopted a /usr merge setup.

Use XML entities from man/custom-entities.ent to replace configured paths while doing XSLT processing of the original XML files. There was precedent of some files (such as systemd.generator.xml) which were already using this approach.

This addresses most of the (manual) fixes from this patch: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220

The idea of using generic XML entities was presented here: http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html

This patch solves almost all the issues, with the exception of:
- Path to /bin/mount and /bin/umount.
- Generic statements about preference of /lib over /etc.

These will be handled separately by follow up patches.

Tested:- With default configure settings, ran "make install" to two separate directories and compared the output to confirm they matched exactly.- Used a set of configure flags including $CONFFLAGS from Debian: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules Installed the tree and confirmed the paths use /lib/systemd instead of /usr/lib/systemd and that no other unexpected differences exist.
- Confirmed that `make distcheck` still passes.

681eb9c man: generate configured paths in manpages
man/binfmt.d.xml | 5 ++++-
man/bootchart.conf.xml | 17 +++++++++------
man/bootctl.xml | 5 ++++-
man/bootup.xml | 5 ++++-
man/busctl.xml | 5 ++++-
man/coredump.conf.xml | 11 ++++++----
man/coredumpctl.xml | 5 ++++-
man/crypttab.xml | 5 ++++-
man/daemon.xml | 5 ++++-
man/file-hierarchy.xml | 5 ++++-
man/halt.xml | 5 ++++-
man/hostname.xml | 5 ++++-
man/hostnamectl.xml | 5 ++++-
man/hwdb.xml | 9 +++++---
man/journal-remote.conf.xml | 11 ++++++----
man/journalctl.xml | 5 ++++-
man/journald.conf.xml | 11 ++++++----
man/kernel-command-line.xml | 5 ++++-
man/kernel-install.xml | 5 ++++-
man/less-variables.xml | 5 ++++-
man/libsystemd-pkgconfig.xml | 5 ++++-
man/locale.conf.xml | 5 ++++-
man/localectl.xml | 5 ++++-
man/localtime.xml | 5 ++++-
man/loginctl.xml | 5 ++++-
man/logind.conf.xml | 11 ++++++----
man/machine-id.xml | 5 ++++-
man/machine-info.xml | 5 ++++-
man/machinectl.xml | 9 +++++---
man/modules-load.d.xml | 5 ++++-
man/networkctl.xml | 5 ++++-
man/nss-myhostname.xml | 5 ++++-
man/nss-mymachines.xml | 5 ++++-
man/os-release.xml | 5 ++++-
man/pam_systemd.xml | 5 ++++-
man/resolved.conf.xml | 11 ++++++----
man/runlevel.xml | 5 ++++-
man/sd-daemon.xml | 5 ++++-
man/sd-id128.xml | 5 ++++-
man/sd-journal.xml | 5 ++++-
man/sd-login.xml | 5 ++++-
man/sd_booted.xml | 5 ++++-
man/sd_bus_creds_get_pid.xml | 5 ++++-
man/sd_bus_creds_new_from_pid.xml | 5 ++++-
man/sd_bus_default.xml | 5 ++++-
man/sd_bus_error.xml | 5 ++++-
man/sd_bus_message_append.xml | 5 ++++-
man/sd_bus_message_append_array.xml | 5 ++++-
man/sd_bus_message_append_basic.xml | 5 ++++-
man/sd_bus_message_append_string_memfd.xml | 5 ++++-
man/sd_bus_message_append_strv.xml | 5 ++++-
man/sd_bus_message_get_cookie.xml | 5 ++++-
man/sd_bus_message_get_monotonic_usec.xml | 5 ++++-
man/sd_bus_negotiate_fds.xml | 5 ++++-
man/sd_bus_new.xml | 5 ++++-
man/sd_bus_path_encode.xml | 5 ++++-
man/sd_bus_request_name.xml | 5 ++++-
man/sd_event_add_child.xml | 5 ++++-
man/sd_event_add_defer.xml | 5 ++++-
man/sd_event_add_signal.xml | 5 ++++-
man/sd_event_add_time.xml | 5 ++++-
man/sd_event_get_fd.xml | 5 ++++-
man/sd_event_new.xml | 5 ++++-
man/sd_event_run.xml | 5 ++++-
man/sd_event_set_name.xml | 5 ++++-
man/sd_event_wait.xml | 5 ++++-
man/sd_get_seats.xml | 5 ++++-
man/sd_id128_get_machine.xml | 5 ++++-
man/sd_id128_randomize.xml | 5 ++++-
man/sd_id128_to_string.xml | 5 ++++-
man/sd_is_fifo.xml | 5 ++++-
man/sd_journal_add_match.xml | 5 ++++-
man/sd_journal_get_catalog.xml | 5 ++++-
man/sd_journal_get_cursor.xml | 5 ++++-
man/sd_journal_get_cutoff_realtime_usec.xml | 5 ++++-
man/sd_journal_get_data.xml | 5 ++++-
man/sd_journal_get_fd.xml | 5 ++++-
man/sd_journal_get_realtime_usec.xml | 5 ++++-
man/sd_journal_get_usage.xml | 5 ++++-
man/sd_journal_next.xml | 5 ++++-
man/sd_journal_open.xml | 5 ++++-
man/sd_journal_print.xml | 5 ++++-
man/sd_journal_query_unique.xml | 5 ++++-
man/sd_journal_seek_head.xml | 5 ++++-
man/sd_journal_stream_fd.xml | 5 ++++-
man/sd_listen_fds.xml | 5 ++++-
man/sd_login_monitor_new.xml | 5 ++++-
man/sd_machine_get_class.xml | 5 ++++-
man/sd_notify.xml | 5 ++++-
man/sd_pid_get_session.xml | 5 ++++-
man/sd_seat_get_active.xml | 5 ++++-
man/sd_session_is_active.xml | 5 ++++-
man/sd_uid_get_state.xml | 5 ++++-
man/sd_watchdog_enabled.xml | 5 ++++-
man/shutdown.xml | 5 ++++-
man/standard-conf.xml | 9 +++++---
man/standard-options.xml | 5 ++++-
man/sysctl.d.xml | 7 ++++--
man/systemctl.xml | 5 ++++-
man/systemd-activate.xml | 11 ++++++----
man/systemd-analyze.xml | 5 ++++-
man/systemd-ask-password-console.service.xml | 5 ++++-
man/systemd-ask-password.xml | 5 ++++-
man/systemd-backlight@.service.xml | 7 ++++--
man/systemd-binfmt.service.xml | 7 ++++--
man/systemd-bootchart.xml | 13 ++++++-----
man/systemd-bus-proxyd.xml | 7 ++++--
man/systemd-bus-proxyd@.service.xml | 5 ++++-
man/systemd-cat.xml | 5 ++++-
man/systemd-cgls.xml | 5 ++++-
man/systemd-cgtop.xml | 5 ++++-
man/systemd-coredump.xml | 7 ++++--
man/systemd-cryptsetup-generator.xml | 7 ++++--
man/systemd-cryptsetup@.service.xml | 7 ++++--
man/systemd-debug-generator.xml | 7 ++++--
man/systemd-delta.xml | 5 ++++-
man/systemd-detect-virt.xml | 5 ++++-
man/systemd-efi-boot-generator.xml | 7 ++++--
man/systemd-escape.xml | 5 ++++-
man/systemd-firstboot.xml | 5 ++++-
man/systemd-fsck@.service.xml | 7 ++++--
man/systemd-fstab-generator.xml | 7 ++++--
man/systemd-getty-generator.xml | 7 ++++--
man/systemd-gpt-auto-generator.xml | 7 ++++--
man/systemd-halt.service.xml | 11 ++++++----
man/systemd-hibernate-resume-generator.xml | 7 ++++--
man/systemd-hibernate-resume@.service.xml | 7 ++++--
man/systemd-hostnamed.service.xml | 7 ++++--
man/systemd-hwdb.xml | 7 ++++--
man/systemd-inhibit.xml | 5 ++++-
man/systemd-initctl.service.xml | 7 ++++--
man/systemd-journal-gatewayd.service.xml | 7 ++++--
man/systemd-journal-remote.xml | 5 ++++-
man/systemd-journal-upload.xml | 9 +++++---
man/systemd-journald.service.xml | 9 +++++---
man/systemd-localed.service.xml | 7 ++++--
man/systemd-logind.service.xml | 7 ++++--
man/systemd-machine-id-commit.service.xml | 7 ++++--
man/systemd-machine-id-commit.xml | 5 ++++-
man/systemd-machine-id-setup.xml | 5 ++++-
man/systemd-machined.service.xml | 7 ++++--
man/systemd-modules-load.service.xml | 7 ++++--
man/systemd-networkd-wait-online.service.xml | 7 ++++--
man/systemd-networkd.service.xml | 11 ++++++----
man/systemd-notify.xml | 5 ++++-
man/systemd-nspawn.xml | 5 ++++-
man/systemd-path.xml | 5 ++++-
man/systemd-quotacheck.service.xml | 7 ++++--
man/systemd-random-seed.service.xml | 7 ++++--
man/systemd-remount-fs.service.xml | 7 ++++--
man/systemd-resolved.service.xml | 7 ++++--
man/systemd-rfkill@.service.xml | 7 ++++--
man/systemd-run.xml | 5 ++++-
man/systemd-sleep.conf.xml | 13 ++++++-----
man/systemd-socket-proxyd.xml | 9 +++++---
man/systemd-suspend.service.xml | 13 ++++++-----
man/systemd-sysctl.service.xml | 7 ++++--
man/systemd-system-update-generator.xml | 7 ++++--
man/systemd-system.conf.xml | 17 +++++++++------
man/systemd-sysusers.xml | 5 ++++-
man/systemd-sysv-generator.xml | 7 ++++--
man/systemd-timedated.service.xml | 7 ++++--
man/systemd-timesyncd.service.xml | 7 ++++--
man/systemd-tmpfiles.xml | 5 ++++-
man/systemd-tty-ask-password-agent.xml | 5 ++++-
man/systemd-udevd.service.xml | 7 ++++--
man/systemd-update-done.service.xml | 7 ++++--
man/systemd-update-utmp.service.xml | 7 ++++--
man/systemd-user-sessions.service.xml | 7 ++++--
man/systemd-vconsole-setup.service.xml | 7 ++++--
man/systemd.automount.xml | 5 ++++-
man/systemd.device.xml | 5 ++++-
man/systemd.exec.xml | 5 ++++-
man/systemd.generator.xml | 4 ++--
man/systemd.journal-fields.xml | 5 ++++-
man/systemd.kill.xml | 5 ++++-
man/systemd.link.xml | 11 ++++++----
man/systemd.mount.xml | 5 ++++-
man/systemd.netdev.xml | 27 ++++++++++++-----------
man/systemd.network.xml | 25 +++++++++++----------
man/systemd.path.xml | 5 ++++-
man/systemd.preset.xml | 21 ++++++++++--------
man/systemd.resource-control.xml | 5 ++++-
man/systemd.scope.xml | 5 ++++-
man/systemd.service.xml | 5 ++++-
man/systemd.slice.xml | 5 ++++-
man/systemd.snapshot.xml | 5 ++++-
man/systemd.socket.xml | 5 ++++-
man/systemd.special.xml | 5 ++++-
man/systemd.swap.xml | 5 ++++-
man/systemd.target.xml | 5 ++++-
man/systemd.time.xml | 5 ++++-
man/systemd.timer.xml | 5 ++++-
man/systemd.unit.xml | 30 +++++++++++++-------------
man/systemd.xml | 7 ++++--
man/sysusers.d.xml | 5 ++++-
man/telinit.xml | 5 ++++-
man/timedatectl.xml | 9 +++++---
man/timesyncd.conf.xml | 11 ++++++----
man/tmpfiles.d.xml | 5 ++++-
man/udev.conf.xml | 5 ++++-
man/udev.xml | 9 +++++---
man/udevadm.xml | 5 ++++-
man/user-system-options.xml | 5 ++++-
man/vconsole.conf.xml | 5 ++++-
205 files changed, 969 insertions(+), 360 deletions(-)

Upstream: github.com

  • Share