summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml50
-rw-r--r--documentation/ref-manual/ref-variables.xml59
2 files changed, 109 insertions, 0 deletions
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 @@
2027 </para> 2027 </para>
2028</section> 2028</section>
2029 2029
2030<section id='ref-classes-systemd'>
2031 <title><filename>systemd.bbclass</filename></title>
2032
2033 <para>
2034 The <filename>systemd</filename> class provides support for recipes
2035 that install <filename>systemd</filename> unit files.
2036 </para>
2037
2038 <para>
2039 The functionality for this class is disabled unless you have "systemd"
2040 in
2041 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
2042 </para>
2043
2044 <para>
2045 Under this class, unit files are installed into
2046 <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}${systemd_unitdir}/system</filename>
2047 during the <filename>do_install</filename> task.
2048 If the unit files being installed go into packages other than the
2049 main package, you need to set
2050 <link linkend='var-SYSTEMD_PACKAGES'><filename>SYSTEMD_PACKAGES</filename></link>
2051 in your recipe to identify the packages in which the files will be
2052 installed.
2053 </para>
2054
2055 <para>
2056 You should set
2057 <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link>
2058 to the name of the service file.
2059 You should also use a package name override to indicate the package
2060 to which the value applies.
2061 If the value applies to the recipe's main package, use
2062 <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>.
2063 Here is an example from the connman recipe:
2064 <literallayout class='monospaced'>
2065 SYSTEMD_SERVICE_${PN} = "connman.service"
2066 </literallayout>
2067 Services are set up to start on boot automatically unless
2068 you have set
2069 <link linkend='var-SYSTEMD_AUTO_ENABLE'><filename>SYSTEMD_AUTO_ENABLE</filename></link>
2070 to "disable".
2071 </para>
2072
2073 <para>
2074 For more information on <filename>systemd</filename>, see the
2075 "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-an-initialization-manager'>Selecting an Initialization Manager</ulink>"
2076 section in the Yocto Project Development Manual.
2077 </para>
2078</section>
2079
2030<section id='ref-classes-package_tar'> 2080<section id='ref-classes-package_tar'>
2031 <title><filename>package_tar.bbclass</filename></title> 2081 <title><filename>package_tar.bbclass</filename></title>
2032 2082
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"
6289 </glossdef> 6289 </glossdef>
6290 </glossentry> 6290 </glossentry>
6291 6291
6292 <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm>
6293 <glossdef>
6294 <para>
6295 Enables and disables the <filename>systemd</filename>
6296 service manager.
6297 By default, the service is enabled to automatically start
6298 at boot time.
6299 The default setting is in the
6300 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
6301 class as follows:
6302 <literallayout class='monospaced'>
6303 SYSTEMD_AUTO_ENABLE ??= "enable"
6304 </literallayout>
6305 You can disable the service by setting the variable to
6306 "disable."
6307 </para>
6308 </glossdef>
6309 </glossentry>
6310
6311 <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
6312 <glossdef>
6313 <para>
6314 Specifies the packages into which
6315 <filename>systemd</filename> unit files are installed
6316 when the files need to be installed into packages other
6317 than recipe's main package.
6318 </para>
6319
6320 <para>
6321 The
6322 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
6323 class sets <filename>SYSTEMD_PACKAGES</filename> as follows:
6324 <literallayout class='monospaced'>
6325 SYSTEMD_PACKAGES ?= "${PN}"
6326 </literallayout>
6327 </para>
6328 </glossdef>
6329 </glossentry>
6330
6331 <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm>
6332 <glossdef>
6333 <para>
6334 The service file for the <filename>systemd</filename>
6335 service manager.
6336 </para>
6337
6338 <para>
6339 When you specify this file in your recipe, use a package
6340 name override to indicate the package to which the value
6341 applies when the value applies to a package other than
6342 the recipe's main package.
6343 Here is an example from the connman recipe:
6344 <literallayout class='monospaced'>
6345 SYSTEMD_SERVICE_${PN} = "connman.service"
6346 </literallayout>
6347 </para>
6348 </glossdef>
6349 </glossentry>
6350
6292 </glossdiv> 6351 </glossdiv>
6293 6352
6294 <glossdiv id='var-glossary-t'><title>T</title> 6353 <glossdiv id='var-glossary-t'><title>T</title>