diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index bd1ec36ae3..fa3d8d7df1 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -2027,6 +2027,56 @@ +
+ <filename>systemd.bbclass</filename> + + + The systemd class provides support for recipes + that install systemd unit files. + + + + The functionality for this class is disabled unless you have "systemd" + in + DISTRO_FEATURES. + + + + Under this class, unit files are installed into + ${D}${systemd_unitdir}/system + during the do_install task. + If the unit files being installed go into packages other than the + main package, you need to set + SYSTEMD_PACKAGES + in your recipe to identify the packages in which the files will be + installed. + + + + You should set + SYSTEMD_SERVICE + to the name of the service file. + You should also use a package name override to indicate the package + to which the value applies. + If the value applies to the recipe's main package, use + ${PN}. + Here is an example from the connman recipe: + + SYSTEMD_SERVICE_${PN} = "connman.service" + + Services are set up to start on boot automatically unless + you have set + SYSTEMD_AUTO_ENABLE + to "disable". + + + + For more information on systemd, see the + "Selecting an Initialization Manager" + section in the Yocto Project Development Manual. + +
+
<filename>package_tar.bbclass</filename> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 049c771ea5..60e24ef565 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -6289,6 +6289,65 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SYSTEMD_AUTO_ENABLE + + + Enables and disables the systemd + service manager. + By default, the service is enabled to automatically start + at boot time. + The default setting is in the + systemd + class as follows: + + SYSTEMD_AUTO_ENABLE ??= "enable" + + You can disable the service by setting the variable to + "disable." + + + + + SYSTEMD_PACKAGES + + + Specifies the packages into which + systemd unit files are installed + when the files need to be installed into packages other + than recipe's main package. + + + + The + systemd + class sets SYSTEMD_PACKAGES as follows: + + SYSTEMD_PACKAGES ?= "${PN}" + + + + + + SYSTEMD_SERVICE + + + The service file for the systemd + service manager. + + + + When you specify this file in your recipe, use a package + name override to indicate the package to which the value + applies when the value applies to a package other than + the recipe's main package. + Here is an example from the connman recipe: + + SYSTEMD_SERVICE_${PN} = "connman.service" + + + + + T