diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-09-15 17:56:32 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-09-20 12:04:30 +0200 |
commit | 9353607ef3cff4902296268bab0ccc82dc8b04c2 (patch) | |
tree | a0b87ea460363d5f891a29b598da645385363c5b | |
parent | f2b9345cd2d717fb227e4c6775134e83d09e4790 (diff) | |
download | systemd-9353607ef3cff4902296268bab0ccc82dc8b04c2.tar.gz |
man: substitute path to rc.local in the man page
Different systems use different paths for it and users are confused when the
man page has a path different than the one on the local system.
https://bugzilla.redhat.com/show_bug.cgi?id=1876905
(cherry picked from commit c2ee27a5e7fa1c6a71341579baa2d941c6e3e6e6)
-rw-r--r-- | man/custom-entities.ent.in | 1 | ||||
-rw-r--r-- | man/systemd-rc-local-generator.xml | 33 |
2 files changed, 19 insertions, 15 deletions
diff --git a/man/custom-entities.ent.in b/man/custom-entities.ent.in index 03fe05f1bc..dc4b242fc3 100644 --- a/man/custom-entities.ent.in +++ b/man/custom-entities.ent.in @@ -10,3 +10,4 @@ <!ENTITY MEMORY_ACCOUNTING_DEFAULT @MEMORY_ACCOUNTING_DEFAULT_YES_NO@> <!ENTITY KILL_USER_PROCESSES @KILL_USER_PROCESSES_YES_NO@> <!ENTITY DEBUGTTY @DEBUGTTY@> +<!ENTITY RC_LOCAL_PATH @RC_LOCAL_PATH@> diff --git a/man/systemd-rc-local-generator.xml b/man/systemd-rc-local-generator.xml index 0e607d0bce..b51f50a1e1 100644 --- a/man/systemd-rc-local-generator.xml +++ b/man/systemd-rc-local-generator.xml @@ -1,8 +1,11 @@ -<?xml version="1.0"?> -<!--*-nxml-*--> +<?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- SPDX-License-Identifier: LGPL-2.1+ --> + <refentry id="systemd-rc-local-generator" conditional='HAVE_SYSV_COMPAT'> <refentryinfo> <title>systemd-rc-local-generator</title> @@ -16,7 +19,7 @@ <refnamediv> <refname>systemd-rc-local-generator</refname> - <refpurpose>Compatibility generator for starting <filename>/etc/rc.local</filename> during boot</refpurpose> + <refpurpose>Compatibility generator for starting <filename>&RC_LOCAL_PATH;</filename> during boot</refpurpose> </refnamediv> <refsynopsisdiv> @@ -27,17 +30,17 @@ <title>Description</title> <para><filename>systemd-rc-local-generator</filename> is a generator that checks whether - <filename>/etc/rc.local</filename> exists and is executable, and if it is pulls the - <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running this script - during late boot. Note that the script will be run with slightly different semantics than the original System V - version, which was run "last" in the boot process, which is a concept that does not translate to systemd. The - script is run after <filename>network.target</filename>, but in parallel with most other regular system - services.</para> - - <para>Support for <filename>/etc/rc.local</filename> is provided - for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of - this script today, and instead provide proper unit files with appropriate dependencies for any scripts to run - during the boot process.</para> + <filename>&RC_LOCAL_PATH;</filename> exists and is executable, and if it is pulls the + <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running + this script during late boot. Note that the script will be run with slightly different semantics than the + original System V version, which was run "last" in the boot process, which is a concept that does not + translate to systemd. The script is run after <filename>network.target</filename>, but in parallel with + most other regular system services.</para> + + <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System + V systems only. However, it is strongly recommended to avoid making use of this script today, and instead + provide proper unit files with appropriate dependencies for any scripts to run during the boot process. + Note that the path to the script is set a compile time and varies between distributions.</para> <para><filename>systemd-rc-local-generator</filename> implements <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> |