summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-02 09:46:06 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:43 +0100
commit2aba525b98e59ac64836c8307cb567be07005d49 (patch)
tree638bcbbcdc17a5e29a8a45afd28d09968a0ab098 /documentation/ref-manual
parentf3394914fd209ac186ef6806794dcbd915ef4fed (diff)
downloadpoky-2aba525b98e59ac64836c8307cb567be07005d49.tar.gz
ref-manual: Updates to several variables.
I implemented some review feedback from Paul Eggleton on these variables: TARGET_CFLAGS BUILD_OPTIMIZATION SDKMACHINE IMAGE_ROOTFS_ALIGNMENT IMAGE_DEVICE_TABLES EXTRA_IMAGECMD SSTATE_MIRROR_ALLOW_NETWORK PACKAGE_ARCHS SDK_PACKAGE_ARCHS (From yocto-docs rev: 6fd804376367449494d5a5cfeb7e9bb2f4c04de1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml44
1 files changed, 33 insertions, 11 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index fc81b00227..2de8473bdb 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -932,7 +932,7 @@
932 <glossdef> 932 <glossdef>
933 <para> 933 <para>
934 Specifies the optimization flags passed to the C compiler 934 Specifies the optimization flags passed to the C compiler
935 when building for the host or the SDK. 935 when building for the build host or the SDK.
936 The flags are passed through the 936 The flags are passed through the
937 <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link> 937 <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link>
938 and 938 and
@@ -2350,6 +2350,12 @@
2350 Specifies additional options for the image 2350 Specifies additional options for the image
2351 creation command that has been specified in 2351 creation command that has been specified in
2352 <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>. 2352 <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>.
2353 When setting this variable, you should
2354 use an override for the associated type.
2355 Here is an example:
2356 <literallayout class='monospaced'>
2357 EXTRA_IMAGECMD_ext3 ?= "-i 4096"
2358 </literallayout>
2353 </para> 2359 </para>
2354 </glossdef> 2360 </glossdef>
2355 </glossentry> 2361 </glossentry>
@@ -3196,9 +3202,10 @@
3196 created under <filename>/dev</filename> within the image. 3202 created under <filename>/dev</filename> within the image.
3197 If <filename>IMAGE_DEVICE_TABLES</filename> is not set, 3203 If <filename>IMAGE_DEVICE_TABLES</filename> is not set,
3198 <filename>files/device_table-minimal.txt</filename> is 3204 <filename>files/device_table-minimal.txt</filename> is
3199 used. 3205 used, which is located by
3206 <link linkend='var-BBPATH'><filename>BBPATH</filename></link>.
3200 For details on how you should write device table files, 3207 For details on how you should write device table files,
3201 see the <filename>files/device_table-minimal.txt</filename> 3208 see <filename>files/device_table-minimal.txt</filename>
3202 as an example. 3209 as an example.
3203 </para> 3210 </para>
3204 </glossdef> 3211 </glossdef>
@@ -3533,7 +3540,7 @@
3533 If the size of the image is not a multiple of 3540 If the size of the image is not a multiple of
3534 this value, then the size is rounded up to the nearest 3541 this value, then the size is rounded up to the nearest
3535 multiple of the value. 3542 multiple of the value.
3536 The default value is 1 Kbyte. 3543 The default value is "1".
3537 See 3544 See
3538 <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link> 3545 <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link>
3539 for additional information. 3546 for additional information.
@@ -5478,10 +5485,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5478 <para> 5485 <para>
5479 Specifies a list of architectures compatible with 5486 Specifies a list of architectures compatible with
5480 the target machine. 5487 the target machine.
5481 Separate the entries using spaces and list them in order
5482 of priority.
5483 This variable is set automatically and should not 5488 This variable is set automatically and should not
5484 normally be hand-edited. 5489 normally be hand-edited.
5490 Entries are separated using spaces and listed in order
5491 of priority.
5485 The default value for 5492 The default value for
5486 <filename>PACKAGE_ARCHS</filename> is "all any noarch 5493 <filename>PACKAGE_ARCHS</filename> is "all any noarch
5487 ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". 5494 ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
@@ -7096,10 +7103,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7096 <para> 7103 <para>
7097 Specifies a list of architectures compatible with 7104 Specifies a list of architectures compatible with
7098 the SDK machine. 7105 the SDK machine.
7099 Separate the entries using spaces and list them in order
7100 of priority.
7101 This variable is set automatically and should not 7106 This variable is set automatically and should not
7102 normally be hand-edited. 7107 normally be hand-edited.
7108 Entries are separated using spaces and listed in order
7109 of priority.
7103 The default value for 7110 The default value for
7104 <filename>SDK_PACKAGE_ARCHS</filename> is "all any noarch 7111 <filename>SDK_PACKAGE_ARCHS</filename> is "all any noarch
7105 ${SDK_ARCH}-${SDKPKGSUFFIX}". 7112 ${SDK_ARCH}-${SDKPKGSUFFIX}".
@@ -7132,6 +7139,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7132 <filename>.conf</filename> file under 7139 <filename>.conf</filename> file under
7133 <filename>conf/machine-sdk/</filename>. 7140 <filename>conf/machine-sdk/</filename>.
7134 </para> 7141 </para>
7142
7143 <para>
7144 You can use "i686" and "x86_64" as possible values
7145 for this variable. The variable defaults to "i686"
7146 and is set in the local.conf file in the Build Directory.
7147 <literallayout class='monospaced'>
7148 SDKMACHINE ?= "i686"
7149 </literallayout>
7150 <note>
7151 You cannot set the <filename>SDKMACHINE</filename>
7152 variable in your distribution configuration file.
7153 If you do, the configuration will not take affect.
7154 </note>
7155 </para>
7135 </glossdef> 7156 </glossdef>
7136 </glossentry> 7157 </glossentry>
7137 7158
@@ -7161,7 +7182,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7161 <para> 7182 <para>
7162 Specifies the optimization flags passed to the C compiler 7183 Specifies the optimization flags passed to the C compiler
7163 when building for the target. 7184 when building for the target.
7164 The flags are passed through the default 7185 The flags are passed through the default value of the
7165 <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link> 7186 <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link>
7166 variable. 7187 variable.
7167 </para> 7188 </para>
@@ -7635,8 +7656,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7635 If set to "1", allows fetches from 7656 If set to "1", allows fetches from
7636 mirrors that are specified in 7657 mirrors that are specified in
7637 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> 7658 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
7638 to work even when <filename>BB_NO_NETWORK</filename> 7659 to work even when fetching from the network has been
7639 is set to "1", which disables fetching from the network. 7660 disabled by setting <filename>BB_NO_NETWORK</filename>
7661 to "1".
7640 Using the 7662 Using the
7641 <filename>SSTATE_MIRROR_ALLOW_NETWORK</filename> 7663 <filename>SSTATE_MIRROR_ALLOW_NETWORK</filename>
7642 variable is useful if you have set 7664 variable is useful if you have set