summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi@buzzcollectivemarketing.com>2018-01-11 15:56:12 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:29 +0000
commita59c06833cff0ae020b796ce81aee84e45a31e64 (patch)
treeb8a5e0c29353f58ddc6a7be612292129b0bca9a2 /documentation/ref-manual/ref-variables.xml
parent635bec34d0d142f2c9f06f6b746573760134ebdc (diff)
downloadpoky-a59c06833cff0ae020b796ce81aee84e45a31e64.tar.gz
ref-manual: Variable Definition Edits for documentation.conf
Fixes [YOCTO #5600] Grammar scrub of variable definitions in documentation.conf (From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml99
1 files changed, 49 insertions, 50 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 3142b3f9e6..29f227e58c 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6159,12 +6159,12 @@
6159 6159
6160 <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm> 6160 <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm>
6161 <info> 6161 <info>
6162 IMAGE_PKGTYPE[doc] = "Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." 6162 IMAGE_PKGTYPE[doc] = "Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system."
6163 </info> 6163 </info>
6164 <glossdef> 6164 <glossdef>
6165 <para role="glossdeffirst"> 6165 <para role="glossdeffirst">
6166<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 6166<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6167 Defines the package type (DEB, RPM, IPK, or TAR) used 6167 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used
6168 by the OpenEmbedded build system. 6168 by the OpenEmbedded build system.
6169 The variable is defined appropriately by the 6169 The variable is defined appropriately by the
6170 <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, 6170 <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>,
@@ -6211,13 +6211,13 @@
6211 6211
6212 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> 6212 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
6213 <info> 6213 <info>
6214 IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the final image output files." 6214 IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the final image output files."
6215 </info> 6215 </info>
6216 <glossdef> 6216 <glossdef>
6217 <para role="glossdeffirst"> 6217 <para role="glossdeffirst">
6218<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 6218<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6219 Specifies a list of functions to call once the 6219 Specifies a list of functions to call once the
6220 OpenEmbedded build system has created the final image 6220 OpenEmbedded build system creates the final image
6221 output files. 6221 output files.
6222 You can specify functions separated by semicolons: 6222 You can specify functions separated by semicolons:
6223 <literallayout class='monospaced'> 6223 <literallayout class='monospaced'>
@@ -6239,13 +6239,13 @@
6239 6239
6240 <glossentry id='var-IMAGE_PREPROCESS_COMMAND'><glossterm>IMAGE_PREPROCESS_COMMAND</glossterm> 6240 <glossentry id='var-IMAGE_PREPROCESS_COMMAND'><glossterm>IMAGE_PREPROCESS_COMMAND</glossterm>
6241 <info> 6241 <info>
6242 IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the final image output files." 6242 IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system creates the final image output files."
6243 </info> 6243 </info>
6244 <glossdef> 6244 <glossdef>
6245 <para role="glossdeffirst"> 6245 <para role="glossdeffirst">
6246<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 6246<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6247 Specifies a list of functions to call before the 6247 Specifies a list of functions to call before the
6248 OpenEmbedded build system has created the final image 6248 OpenEmbedded build system creates the final image
6249 output files. 6249 output files.
6250 You can specify functions separated by semicolons: 6250 You can specify functions separated by semicolons:
6251 <literallayout class='monospaced'> 6251 <literallayout class='monospaced'>
@@ -7111,7 +7111,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7111 7111
7112 <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> 7112 <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm>
7113 <info> 7113 <info>
7114 KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched and configured during a build." 7114 KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched, and configured during a build."
7115 </info> 7115 </info>
7116 <glossdef> 7116 <glossdef>
7117 <para role="glossdeffirst"> 7117 <para role="glossdeffirst">
@@ -7258,7 +7258,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7258 7258
7259 <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm> 7259 <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm>
7260 <info> 7260 <info>
7261 KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the <filename>.dtb</filename>) file." 7261 KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the .dtb) file."
7262 </info> 7262 </info>
7263 <glossdef> 7263 <glossdef>
7264 <para role="glossdeffirst"> 7264 <para role="glossdeffirst">
@@ -7869,13 +7869,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7869 7869
7870 <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm> 7870 <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm>
7871 <info> 7871 <info>
7872 LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (.so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." 7872 LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (i.e. .so) that the debian class applies its naming policy to given a recipe that packages multiple libraries."
7873 </info> 7873 </info>
7874 <glossdef> 7874 <glossdef>
7875 <para role="glossdeffirst"> 7875 <para role="glossdeffirst">
7876<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 7876<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7877 Specifies the lead (or primary) compiled library file 7877 Specifies the lead (or primary) compiled library file
7878 (<filename>.so</filename>) that the 7878 (i.e. <filename>.so</filename>) that the
7879 <link linkend='ref-classes-debian'><filename>debian</filename></link> 7879 <link linkend='ref-classes-debian'><filename>debian</filename></link>
7880 class applies its naming policy to given a recipe that 7880 class applies its naming policy to given a recipe that
7881 packages multiple libraries. 7881 packages multiple libraries.
@@ -8289,7 +8289,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8289 8289
8290 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm> 8290 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
8291 <info> 8291 <info>
8292 MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." 8292 MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot."
8293 </info> 8293 </info>
8294 <glossdef> 8294 <glossdef>
8295 <para role="glossdeffirst"> 8295 <para role="glossdeffirst">
@@ -8297,7 +8297,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8297 A list of required machine-specific packages to install as part of 8297 A list of required machine-specific packages to install as part of
8298 the image being built. 8298 the image being built.
8299 The build process depends on these packages being present. 8299 The build process depends on these packages being present.
8300 Furthermore, because this is a "machine essential" variable, the list of 8300 Furthermore, because this is a "machine-essential" variable, the list of
8301 packages are essential for the machine to boot. 8301 packages are essential for the machine to boot.
8302 The impact of this variable affects images based on 8302 The impact of this variable affects images based on
8303 <filename>packagegroup-core-boot</filename>, 8303 <filename>packagegroup-core-boot</filename>,
@@ -8326,7 +8326,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8326 8326
8327 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm> 8327 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
8328 <info> 8328 <info>
8329 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." 8329 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot."
8330 </info> 8330 </info>
8331 <glossdef> 8331 <glossdef>
8332 <para role="glossdeffirst"> 8332 <para role="glossdeffirst">
@@ -8334,7 +8334,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8334 A list of recommended machine-specific packages to install as part of 8334 A list of recommended machine-specific packages to install as part of
8335 the image being built. 8335 the image being built.
8336 The build process does not depend on these packages being present. 8336 The build process does not depend on these packages being present.
8337 However, because this is a "machine essential" variable, the list of 8337 However, because this is a "machine-essential" variable, the list of
8338 packages are essential for the machine to boot. 8338 packages are essential for the machine to boot.
8339 The impact of this variable affects images based on 8339 The impact of this variable affects images based on
8340 <filename>packagegroup-core-boot</filename>, 8340 <filename>packagegroup-core-boot</filename>,
@@ -8632,14 +8632,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8632 8632
8633 <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm> 8633 <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm>
8634 <info> 8634 <info>
8635 MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package, such as a Multilib version." 8635 MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package (i.e. a Multilib version)."
8636 </info> 8636 </info>
8637 <glossdef> 8637 <glossdef>
8638 <para role="glossdeffirst"> 8638 <para role="glossdeffirst">
8639<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 8639<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
8640 Specifies a prefix has been added to 8640 Specifies a prefix has been added to
8641 <link linkend='var-PN'><filename>PN</filename></link> to create a special version 8641 <link linkend='var-PN'><filename>PN</filename></link> to create a special version
8642 of a recipe or package, such as a Multilib version. 8642 of a recipe or package (i.e. a Multilib version).
8643 The variable is used in places where the prefix needs to be 8643 The variable is used in places where the prefix needs to be
8644 added to or removed from a the name (e.g. the 8644 added to or removed from a the name (e.g. the
8645 <link linkend='var-BPN'><filename>BPN</filename></link> variable). 8645 <link linkend='var-BPN'><filename>BPN</filename></link> variable).
@@ -8930,7 +8930,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8930 8930
8931 <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm> 8931 <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm>
8932 <info> 8932 <info>
8933 NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." 8933 NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed."
8934 </info> 8934 </info>
8935 <glossdef> 8935 <glossdef>
8936 <para role="glossdeffirst"> 8936 <para role="glossdeffirst">
@@ -10014,12 +10014,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10014 10014
10015 <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> 10015 <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
10016 <info> 10016 <info>
10017 PACKAGES[doc] = "The list of packages to be created from the recipe." 10017 PACKAGES[doc] = "The list of packages the recipe creates."
10018 </info> 10018 </info>
10019 <glossdef> 10019 <glossdef>
10020 <para role="glossdeffirst"> 10020 <para role="glossdeffirst">
10021<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 10021<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
10022 The list of packages to be created from the recipe. 10022 The list of packages the recipe creates.
10023 The default value is the following: 10023 The default value is the following:
10024 <literallayout class='monospaced'> 10024 <literallayout class='monospaced'>
10025 ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} 10025 ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
@@ -10517,7 +10517,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10517 10517
10518 <glossentry id='var-PN'><glossterm>PN</glossterm> 10518 <glossentry id='var-PN'><glossterm>PN</glossterm>
10519 <info> 10519 <info>
10520 PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." 10520 PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package.
10521 </info> 10521 </info>
10522 <glossdef> 10522 <glossdef>
10523 <para role="glossdeffirst"> 10523 <para role="glossdeffirst">
@@ -10858,7 +10858,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10858 10858
10859 <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm> 10859 <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm>
10860 <info> 10860 <info>
10861 PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard' and 'extra'." 10861 PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard', and 'extra'."
10862 </info> 10862 </info>
10863 <glossdef> 10863 <glossdef>
10864 <para role="glossdeffirst"> 10864 <para role="glossdeffirst">
@@ -12200,13 +12200,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12200 12200
12201 <glossentry id='var-SDK_POSTPROCESS_COMMAND'><glossterm>SDK_POSTPROCESS_COMMAND</glossterm> 12201 <glossentry id='var-SDK_POSTPROCESS_COMMAND'><glossterm>SDK_POSTPROCESS_COMMAND</glossterm>
12202 <info> 12202 <info>
12203 SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the SDK." 12203 SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the SDK."
12204 </info> 12204 </info>
12205 <glossdef> 12205 <glossdef>
12206 <para role="glossdeffirst"> 12206 <para role="glossdeffirst">
12207<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 12207<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12208 Specifies a list of functions to call once the 12208 Specifies a list of functions to call once the
12209 OpenEmbedded build system has created the SDK. 12209 OpenEmbedded build system creates the SDK.
12210 You can specify functions separated by semicolons: 12210 You can specify functions separated by semicolons:
12211 <literallayout class='monospaced'> 12211 <literallayout class='monospaced'>
12212 SDK_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " 12212 SDK_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
@@ -13150,13 +13150,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13150 13150
13151 <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> 13151 <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
13152 <info> 13152 <info>
13153 SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only." 13153 SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial, and Bazaar only."
13154 </info> 13154 </info>
13155 <glossdef> 13155 <glossdef>
13156 <para role="glossdeffirst"> 13156 <para role="glossdeffirst">
13157<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 13157<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
13158 The revision of the source code used to build the package. 13158 The revision of the source code used to build the package.
13159 This variable applies to Subversion, Git, Mercurial and 13159 This variable applies to Subversion, Git, Mercurial, and
13160 Bazaar only. 13160 Bazaar only.
13161 Note that if you want to build a fixed revision and you 13161 Note that if you want to build a fixed revision and you
13162 want to avoid performing a query on the remote repository 13162 want to avoid performing a query on the remote repository
@@ -13192,7 +13192,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13192 13192
13193 <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm> 13193 <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm>
13194 <info> 13194 <info>
13195 SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network has been disabled by setting BB_NO_NETWORK to "1"." 13195 SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network is disabled by setting BB_NO_NETWORK to "1"."
13196 </info> 13196 </info>
13197 <glossdef> 13197 <glossdef>
13198 <para role="glossdeffirst"> 13198 <para role="glossdeffirst">
@@ -13200,7 +13200,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13200 If set to "1", allows fetches from 13200 If set to "1", allows fetches from
13201 mirrors that are specified in 13201 mirrors that are specified in
13202 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> 13202 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
13203 to work even when fetching from the network has been 13203 to work even when fetching from the network is
13204 disabled by setting <filename>BB_NO_NETWORK</filename> 13204 disabled by setting <filename>BB_NO_NETWORK</filename>
13205 to "1". 13205 to "1".
13206 Using the 13206 Using the
@@ -13741,13 +13741,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13741 13741
13742 <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> 13742 <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
13743 <info> 13743 <info>
13744 SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." 13744 SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm, or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe."
13745 </info> 13745 </info>
13746 <glossdef> 13746 <glossdef>
13747 <para role="glossdeffirst"> 13747 <para role="glossdeffirst">
13748<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 13748<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
13749 The short (72 characters or less) summary of the binary package for packaging 13749 The short (72 characters or less) summary of the binary package for packaging
13750 systems such as <filename>opkg</filename>, <filename>rpm</filename> or 13750 systems such as <filename>opkg</filename>, <filename>rpm</filename>, or
13751 <filename>dpkg</filename>. 13751 <filename>dpkg</filename>.
13752 By default, <filename>SUMMARY</filename> is used to define 13752 By default, <filename>SUMMARY</filename> is used to define
13753 the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link> 13753 the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>
@@ -13759,7 +13759,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13759 13759
13760 <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm> 13760 <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm>
13761 <info> 13761 <info>
13762 SVNDIR[doc] = "The directory where Subversion checkouts will be stored." 13762 SVNDIR[doc] = "The directory where Subversion checkouts are stored."
13763 </info> 13763 </info>
13764 <glossdef> 13764 <glossdef>
13765 <para role="glossdeffirst"> 13765 <para role="glossdeffirst">
@@ -13842,13 +13842,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13842 13842
13843 <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm> 13843 <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm>
13844 <info> 13844 <info>
13845 SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you are using the boot menu." 13845 SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you use the boot menu."
13846 </info> 13846 </info>
13847 <glossdef> 13847 <glossdef>
13848 <para role="glossdeffirst"> 13848 <para role="glossdeffirst">
13849<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 13849<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
13850 An <filename>.LSS</filename> file used as the background 13850 An <filename>.LSS</filename> file used as the background
13851 for the VGA boot menu when you are using the boot menu. 13851 for the VGA boot menu when you use the boot menu.
13852 You need to set this variable in your recipe. 13852 You need to set this variable in your recipe.
13853 </para> 13853 </para>
13854 13854
@@ -13885,7 +13885,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13885 13885
13886 <glossentry id='var-SYSROOT_DESTDIR'><glossterm>SYSROOT_DESTDIR</glossterm> 13886 <glossentry id='var-SYSROOT_DESTDIR'><glossterm>SYSROOT_DESTDIR</glossterm>
13887 <info> 13887 <info>
13888 SYSROOT_DESTDIR[doc] = "Points to the temporary work directory (default ${WORKDIR}/sysroot-destdir) where the files that will be populated into the sysroot are assembled during the do_populate_sysroot task." 13888 SYSROOT_DESTDIR[doc] = "Points to the temporary work directory (default ${WORKDIR}/sysroot-destdir) where the files populated into the sysroot are assembled during the do_populate_sysroot task."
13889 </info> 13889 </info>
13890 <glossdef> 13890 <glossdef>
13891 <para role="glossdeffirst"> 13891 <para role="glossdeffirst">
@@ -13893,8 +13893,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
13893 Points to the temporary directory under the work directory 13893 Points to the temporary directory under the work directory
13894 (default 13894 (default
13895 "<filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/sysroot-destdir</filename>") 13895 "<filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/sysroot-destdir</filename>")
13896 where the files 13896 where the files populated into the sysroot are assembled
13897 that will be populated into the sysroot are assembled
13898 during the 13897 during the
13899 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> 13898 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
13900 task. 13899 task.
@@ -14009,17 +14008,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14009 14008
14010 <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm> 14009 <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm>
14011 <info> 14010 <info>
14012 SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the service you have specified in SYSTEMD_SERVICE should be started automatically or not." 14011 SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the specified service in SYSTEMD_SERVICE should start automatically or not."
14013 </info> 14012 </info>
14014 <glossdef> 14013 <glossdef>
14015 <para role="glossdeffirst"> 14014 <para role="glossdeffirst">
14016<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 14015<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
14017 When inheriting the 14016 When inheriting the
14018 <link linkend='ref-classes-systemd'><filename>systemd</filename></link> 14017 <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
14019 class, this variable specifies whether the service you have 14018 class, this variable specifies whether the specified service
14020 specified in 14019 in
14021 <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link> 14020 <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link>
14022 should be started automatically or not. 14021 should start automatically or not.
14023 By default, the service is enabled to automatically start 14022 By default, the service is enabled to automatically start
14024 at boot time. 14023 at boot time.
14025 The default setting is in the 14024 The default setting is in the
@@ -14067,7 +14066,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14067 14066
14068 <glossentry id='var-SYSTEMD_BOOT_ENTRIES'><glossterm>SYSTEMD_BOOT_ENTRIES</glossterm> 14067 <glossentry id='var-SYSTEMD_BOOT_ENTRIES'><glossterm>SYSTEMD_BOOT_ENTRIES</glossterm>
14069 <info> 14068 <info>
14070 SYSTEMD_BOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." 14069 SYSTEMD_BOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files (*.conf) to install that contain one boot entry per file."
14071 </info> 14070 </info>
14072 <glossdef> 14071 <glossdef>
14073 <para role="glossdeffirst"> 14072 <para role="glossdeffirst">
@@ -14077,8 +14076,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14077 is set to "systemd-boot", the 14076 is set to "systemd-boot", the
14078 <filename>SYSTEMD_BOOT_ENTRIES</filename> variable specifies 14077 <filename>SYSTEMD_BOOT_ENTRIES</filename> variable specifies
14079 a list of entry files 14078 a list of entry files
14080 (<filename>*.conf</filename>) to be installed 14079 (<filename>*.conf</filename>) to install that contain
14081 containing one boot entry per file. 14080 one boot entry per file.
14082 By default, the 14081 By default, the
14083 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> 14082 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
14084 class sets the <filename>SYSTEMD_BOOT_ENTRIES</filename> as 14083 class sets the <filename>SYSTEMD_BOOT_ENTRIES</filename> as
@@ -14180,7 +14179,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14180 14179
14181 <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm> 14180 <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm>
14182 <info> 14181 <info>
14183 SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should be running a getty, the default is '1'." 14182 SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should run a getty, the default is '1'."
14184 </info> 14183 </info>
14185 <glossdef> 14184 <glossdef>
14186 <para role="glossdeffirst"> 14185 <para role="glossdeffirst">
@@ -14188,7 +14187,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14188 When using 14187 When using
14189 <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, 14188 <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>,
14190 specifies a space-separated list of the virtual terminals 14189 specifies a space-separated list of the virtual terminals
14191 that should be running a 14190 that should run a
14192 <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink> 14191 <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink>
14193 (allowing login), assuming 14192 (allowing login), assuming
14194 <link linkend='var-USE_VT'><filename>USE_VT</filename></link> 14193 <link linkend='var-USE_VT'><filename>USE_VT</filename></link>
@@ -14775,7 +14774,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14775 14774
14776 <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> 14775 <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm>
14777 <info> 14776 <info>
14778 TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to "${WORKDIR}/testimage"." 14777 TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"."
14779 </info> 14778 </info>
14780 <glossdef> 14779 <glossdef>
14781 <para role="glossdeffirst"> 14780 <para role="glossdeffirst">
@@ -15853,7 +15852,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15853 15852
15854 <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm> 15853 <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm>
15855 <info> 15854 <info>
15856 UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled." 15855 UPDATERCPN[doc] = "Specifies the package that contains the initscript that is enabled."
15857 </info> 15856 </info>
15858 <glossdef> 15857 <glossdef>
15859 <para role="glossdeffirst"> 15858 <para role="glossdeffirst">
@@ -15861,7 +15860,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15861 For recipes inheriting the 15860 For recipes inheriting the
15862 <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> 15861 <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link>
15863 class, <filename>UPDATERCPN</filename> specifies 15862 class, <filename>UPDATERCPN</filename> specifies
15864 the package that contains the initscript that is to be 15863 the package that contains the initscript that is
15865 enabled. 15864 enabled.
15866 </para> 15865 </para>
15867 15866
@@ -16149,7 +16148,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
16149 16148
16150 <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> 16149 <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm>
16151 <info> 16150 <info>
16152 USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the useradd command if you wish to add a user to the system when the package is installed." 16151 USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should pass to the useradd command if you add a user to the system when the package is installed."
16153 </info> 16152 </info>
16154 <glossdef> 16153 <glossdef>
16155 <para role="glossdeffirst"> 16154 <para role="glossdeffirst">
@@ -16157,9 +16156,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
16157 When inheriting the 16156 When inheriting the
16158 <link linkend='ref-classes-useradd'><filename>useradd</filename></link> 16157 <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
16159 class, this variable 16158 class, this variable
16160 specifies for a package what parameters should be passed 16159 specifies for a package what parameters should pass
16161 to the <filename>useradd</filename> command 16160 to the <filename>useradd</filename> command
16162 if you wish to add a user to the system when the package 16161 if you add a user to the system when the package
16163 is installed. 16162 is installed.
16164 </para> 16163 </para>
16165 16164