mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00
Code Issues Projects Releases Wiki Activity

dev-manual, ref-manual: Review edits for new variables.

Browse Source 
Applied review changes to the following variables:

IMAGE_NAME
DATETIME
SDK_ARCH
IMAGE_BASENAME
TUNE_PKGARCH
PACKAGE_GROUP
COMPLEMENTARY_GLOB
BUSYBOX_SPLIT_SUID

Also, reformatted some 1.5 package version requirements into a
list rather than a lazy literallayout tag.

Provided some new wording for the "Directory Layout Changes"
section in the Migration chapter.

(From yocto-docs rev: 60c3a905dd9212f1b4f6969341640a0726342d11)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2013-09-27 13:58:02 -07:00
committed by Richard Purdie
parent df2e70a3af
commit 0d194a8c62
3 changed files with 190 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-variables.xml
+68 -13
View File
@@ -822,7 +822,18 @@ Core layer for images cannot be removed
<glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
<glossdef>
<para>
Need description.
For the BusyBox recipe, specifies whether to split the
output executable file into two parts: one for features
that require <filename>setuid root</filename>, and one for
the remaining features (i.e. those that do not require
<filename>setuid root</filename>).
</para>
<para>
The <filename>BUSYBOX_SPLIT_SUID</filename> variable
defaults to "1", which results in a single output
executable file.
Set the variable to "0" to split the output file.
</para>
</glossdef>
</glossentry>
@@ -893,10 +904,29 @@ Core layer for images cannot be removed
</glossdef>
</glossentry>
<glossentry id='var-COMPLEMENTARY_GLOBS'><glossterm>COMPLEMENTARY_GLOBS</glossterm>
<glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
<glossdef>
<para>
Need description.
Defines wildcards you can use when installing a list of
complementary packages for all the packages explicitly
(or implicitly) installed in an image.
The resulting list of complementary packages is associated
with an item that can be added to
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
An example usage of this is the "dev-pkgs" item that when
added to <filename>IMAGE_FEATURES</filename> will
install -dev packages (containing headers and other
development files) for every package in the image.
</para>
<para>
To add a new feature item pointing to a wildcard, use a
variable flag to specify the feature item name and
use the value to specify the wildcard.
Here is an example:
<literallayout class='monospaced'>
COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
</literallayout>
</para>
</glossdef>
</glossentry>
@@ -1013,10 +1043,8 @@ Core layer for images cannot be removed
<glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
<glossdef>
<para>
The date and time on which the build started:
<literallayout class='monospaced'>
date/time
</literallayout>
The date and time on which the current build started.
The format is suitable for timestamps.
</para>
</glossdef>
</glossentry>
@@ -1883,7 +1911,9 @@ Core layer for images cannot be removed
<glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
<glossdef>
<para>
Need description.
The base name of image output files.
This variable defaults to the recipe name
(<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
</para>
</glossdef>
</glossentry>
@@ -2032,8 +2062,8 @@ Core layer for images cannot be removed
<para>
The name of the output image files minus the extension.
This variable is derived using the
<link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>
<link linkend='var-MACHINE'><filename>MACHINE</filename></link>
<link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
<link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
and
<link linkend='var-DATETIME'><filename>DATETIME</filename></link>
variables:
@@ -3675,7 +3705,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
<glossdef>
<para>
Need description.
Defines one or more packages to include in an image when
a specific item is included in
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
When setting the value, <filename>PACKAGE_GROUP</filename>
should have the name of the feature item as an override.
Here is an example:
<literallayout class='monospaced'>
PACKAGE_GROUP_widget = "package1 package2"
</literallayout>
In this example, if "widget" were added to
<filename>IMAGE_FEATURES</filename>, "package1" and
"package2" would be included in the image.
<note>
Packages installed by features defined through
<filename>PACKAGE_GROUP</filename> are often package
groups.
While similarly named, you should not confuse the
<filename>PACKAGE_GROUP</filename> variable with
package groups, which are discussed elsewhere in the
documentation.
</note>
</para>
</glossdef>
</glossentry>
@@ -4630,7 +4680,10 @@ PARALLEL_MAKEINST with the description ".
<glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
<glossdef>
<para>
Need description.
The target architecture for the SDK.
Typically, you do not directly set this variable.
Instead, use
<link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
</para>
</glossdef>
</glossentry>
@@ -5570,7 +5623,9 @@ PARALLEL_MAKEINST with the description ".
<glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
<glossdef>
<para>
Need description.
The package architecture understood by the packaging
system to define the architecture, ABI, and tuning of
output packages.
</para>
</glossdef>
</glossentry>