summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-21 14:59:52 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-01 12:15:01 +0100
commit4396ffb3c9faace1791ef921e75955a45f27a8ab (patch)
tree4dbf28847f01ce49302d1a52dae99adbe4fe6538 /documentation/ref-manual
parent05beac3ef05c38862254b9ba9922961637fb3b72 (diff)
downloadpoky-4396ffb3c9faace1791ef921e75955a45f27a8ab.tar.gz
ref-manual: Updated STAGING_DIR_TARGET and MULTIMACH* variables.
Fixes [YOCTO #9988] Updated the STAGING_DIR_TARGET variable with a better introductory sentence. Updated the MULTIMACH_TARGET_SYS variable with a more expanded explanation. Added a new glossary entry for the MULTIMACH_HOST_SYS variable. (From yocto-docs rev: d17873d695772b62325de35dd0e5b9ccc7f12f1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml69
1 files changed, 58 insertions, 11 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index d31c94c9e3..f829a6a7bd 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -8035,6 +8035,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8035 </glossdef> 8035 </glossdef>
8036 </glossentry> 8036 </glossentry>
8037 8037
8038 <glossentry id='var-MULTIMACH_HOST_SYS'><glossterm>MULTIMACH_HOST_SYS</glossterm>
8039 <info>
8040 MULTIMACH_HOST_SYS[doc] = "Separates files for different machines such that you can build for multiple host machines using the same output directories."
8041 </info>
8042 <glossdef>
8043 <para role="glossdeffirst">
8044<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
8045 Serves the same purpose as
8046 <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>,
8047 but for the "HOST" system, in situations that involve a
8048 "HOST" and a "TARGET" system.
8049 See the
8050 <link linkend='var-STAGING_DIR_TARGET'><filename>STAGING_DIR_TARGET</filename></link>
8051 variable for more information.
8052 </para>
8053
8054 <para>
8055 The default value of this variable is:
8056 <literallayout class='monospaced'>
8057 ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS}
8058 </literallayout>
8059 </para>
8060 </glossdef>
8061 </glossentry>
8062
8038 <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm> 8063 <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm>
8039 <info> 8064 <info>
8040 MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories." 8065 MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories."
@@ -8042,10 +8067,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8042 <glossdef> 8067 <glossdef>
8043 <para role="glossdeffirst"> 8068 <para role="glossdeffirst">
8044<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 8069<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
8045 Separates files for different machines such that you can build 8070 Uniquely identifies the type of the target system for
8046 for multiple target machines using the same output directories. 8071 which packages are being built.
8047 See the <link linkend='var-STAMP'><filename>STAMP</filename></link> variable 8072 This variable allows output for different types of target
8048 for an example. 8073 systems to be put into different subdirectories of the same
8074 output directory.
8075 </para>
8076
8077 <para>
8078 The default value of this variable is:
8079 <literallayout class='monospaced'>
8080 ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}
8081 </literallayout>
8082 Some classes (e.g.
8083 <link linkend='ref-classes-cross-canadian'><filename>cross-canadian</filename></link>)
8084 modify the <filename>MULTIMACH_TARGET_SYS</filename> value.
8085 </para>
8086
8087 <para>
8088 See the
8089 <link linkend='var-STAMP'><filename>STAMP</filename></link>
8090 variable for an example.
8091 <link linkend='var-MULTIMACH_HOST_SYS'><filename>MULTIMACH_HOST_SYS</filename></link>
8092 is the corresponding variable for the host system in
8093 situations that involve a "HOST" and a "TARGET" system.
8094 See the
8095 <link linkend='var-STAGING_DIR_TARGET'><filename>STAGING_DIR_TARGET</filename></link>
8096 variable for more information.
8049 </para> 8097 </para>
8050 </glossdef> 8098 </glossdef>
8051 </glossentry> 8099 </glossentry>
@@ -12320,14 +12368,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12320 12368
12321 <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm> 12369 <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm>
12322 <info> 12370 <info>
12323 STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot used for the "HOST" system." 12371 STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot used for the system for which the component generates code."
12324 </info> 12372 </info>
12325 <glossdef> 12373 <glossdef>
12326 <para role="glossdeffirst"> 12374 <para role="glossdeffirst">
12327<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 12375<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12328 Specifies the path to the sysroot used for the "HOST" 12376 Specifies the path to the sysroot used for the system for
12329 system. 12377 which the component generates code.
12330 In most cases, this path is the 12378 For components that do not generate code, which is the
12379 majority), <filename>STAGING_DIR_TARGET</filename> is set
12380 to match
12331 <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>. 12381 <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>.
12332 </para> 12382 </para>
12333 12383
@@ -12344,9 +12394,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12344 to the sysroot used for the "HOST" system, while 12394 to the sysroot used for the "HOST" system, while
12345 <filename>STAGING_DIR_TARGET</filename> 12395 <filename>STAGING_DIR_TARGET</filename>
12346 points to the sysroot used for the "TARGET" system. 12396 points to the sysroot used for the "TARGET" system.
12347 For recipes where <filename>STAGING_DIR_TARGET</filename>
12348 makes no sense, it is set to match
12349 <filename>STAGING_DIR_HOST</filename>.
12350 </para> 12397 </para>
12351 </glossdef> 12398 </glossdef>
12352 </glossentry> 12399 </glossentry>