diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-07-21 12:08:53 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-08-01 12:15:00 +0100 |
commit | 376a8201d18f5eb8e06d15d11a6e30f96e8eb43d (patch) | |
tree | 9bd561395bb7c0a2a6723a8fc016506272a5d0ac /documentation | |
parent | 599be67eef7679a72db928393ac023e878bfaf65 (diff) | |
download | openembedded-core-contrib-376a8201d18f5eb8e06d15d11a6e30f96e8eb43d.tar.gz |
ref-manual: Augmented some STAGING_DIR_* variable descriptions:
* Updated the STAGING_DIR_HOST description
* Updated the STAGING_DIR_NATIVE description
* Updated the STAGING_DIR_TARGET description
Fixes [YOCTO #9988]
(From yocto-docs rev: cc2c3d849f0919199d1b7960e30ed152f3f0474e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 39 |
1 files changed, 25 insertions, 14 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3e715ff699..2fa7209d47 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -12271,18 +12271,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm> <info> - STAGING_DIR_HOST[doc] = "Specifies the path to the primary sysroot directory for which the target is being built." + STAGING_DIR_HOST[doc] = "Specifies the path to the sysroot directory for the system that the component is built to run on." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the primary sysroot directory for - which the target is being built. - Depending on the type of recipe and the build target, the - recipe's value is as follows: + Specifies the path to the sysroot directory for the system + that the component is built to run on (the system that hosts + the component). + This sysroot is the one that the recipe's + <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> + task copies files into. + Depending on the type of recipe and the build target, + <filename>STAGING_DIR_HOST</filename> can have the + following values: <itemizedlist> <listitem><para>For recipes building for the target - machine, the value is "${STAGING_DIR}/${MACHINE}". + machine, the value is + "${<link linkend='var-STAGING_DIR'>STAGING_DIR</link>}/${<link linkend='var-MACHINE'>MACHINE</link>}". </para></listitem> <listitem><para>For native recipes building for the build host, the value is empty given the @@ -12301,26 +12307,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm> <info> - STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory for the build host." + STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory used when building components that run on the build host itself." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the sysroot directory for the - build host. + Specifies the path to the sysroot directory used when + building components that run on the build host itself. </para> </glossdef> </glossentry> <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm> <info> - STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot directory for the target for which the current recipe is being built." + STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot used for the "HOST" system." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the sysroot directory for the - target for which the current recipe is being built. + Specifies the path to the sysroot used for the "HOST" + system. In most cases, this path is the <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>. </para> @@ -12334,8 +12340,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" referred to as the "TARGET". Thus, the binaries run on the "HOST" system and and generate binaries for the "TARGET" system. - <filename>STAGING_DIR_TARGET</filename> points to the - sysroot used for the "TARGET" system. + The <filename>STAGING_DIR_HOST</filename> variable points + to the sysroot used for the "HOST" system, while + <filename>STAGING_DIR_TARGET</filename> + points to the sysroot used for the "TARGET" system. + For recipes where <filename>STAGING_DIR_TARGET</filename> + makes no sense, it is set to match + <filename>STAGING_DIR_HOST</filename>. </para> </glossdef> </glossentry> |