summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-01-23 15:38:31 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:55 +0000
commitb87690926928061c82f694dd923b15b3b60e40ae (patch)
treea37338af3e15534ce172e462dff90f2a0606673d /documentation
parent93052c9900da497fd4caa7dc8d214797446bb93b (diff)
downloadpoky-b87690926928061c82f694dd923b15b3b60e40ae.tar.gz
adt-manual, ref-manual: Review edits for xcross-toolchain additions.
Mark Hatle reviewed the section and I updated some things based off his input. A rewrite to the "Makefile-Based Projects" section to get it technically correct. Also, removed all SDKROOT documentation from both the adt-manual and ref-manual. Fixes [YOCTO #7133] (From yocto-docs rev: dd785777834611d94868a3774f2eb21ffc081b1a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-command.xml23
-rw-r--r--documentation/adt-manual/adt-prepare.xml1
-rw-r--r--documentation/ref-manual/ref-variables.xml11
3 files changed, 16 insertions, 19 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index 0faa05fa6c..d6fa8ee4d4 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -210,19 +210,28 @@
210<title>Makefile-Based Projects</title> 210<title>Makefile-Based Projects</title>
211 211
212 <para> 212 <para>
213 For Makefile-based projects, you make sure your 213 For Makefile-based projects, the cross-toolchain environment
214 <filename>Makefile</filename> has statements that ensure proper 214 variables established by running the cross-toolchain environment
215 use of the cross-toolchain. 215 setup script override any settings you might have in your
216 For example, the following statements inside a 216 <filename>Makefile</filename>.
217 <filename>Makefile</filename> ensure the C compiler, linker, flags 217 For example, if you had settings such as the following in your
218 passed to the C compiler, and flags passed to the C++ compiler are 218 <filename>Makefile</filename>, the environment variables defined
219 specifically defined for the build: 219 by the script would override them:
220 <literallayout class='monospaced'> 220 <literallayout class='monospaced'>
221 <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=arm-poky-linux-gnueabi-gcc 221 <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=arm-poky-linux-gnueabi-gcc
222 <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=arm-poky-linux-gnueabi-ld 222 <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=arm-poky-linux-gnueabi-ld
223 <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=”${CFLAGS} --sysroot=&lt;sysroot-dir&gt;” 223 <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=”${CFLAGS} --sysroot=&lt;sysroot-dir&gt;”
224 <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=”${CXXFLAGS} --sysroot=&lt;sysroot-dir&gt;” 224 <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=”${CXXFLAGS} --sysroot=&lt;sysroot-dir&gt;”
225 </literallayout> 225 </literallayout>
226 Consequently, you should not set variables like
227 <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'><filename>CC</filename></ulink>
228 and
229 <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink>
230 in your <filename>Makefile</filename>.
231 For the list of variables set up by the cross-toolchain environment
232 setup script, see the
233 "<link linkend='setting-up-the-cross-development-environment'>Setting Up the Cross-Development Environment</link>"
234 section.
226 </para> 235 </para>
227</section> 236</section>
228 237
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index e75e9c95cd..260e1f18a0 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -423,7 +423,6 @@
423 When you run the setup script, many environment variables are 423 When you run the setup script, many environment variables are
424 defined: 424 defined:
425 <literallayout class='monospaced'> 425 <literallayout class='monospaced'>
426 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKROOT'><filename>SDKROOT</filename></ulink> - The path to the installed SDK
427 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKTARGETSYSROOT'><filename>SDKTARGETSYSROOT</filename></ulink> - The path to the sysroot used for cross-compilation 426 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKTARGETSYSROOT'><filename>SDKTARGETSYSROOT</filename></ulink> - The path to the sysroot used for cross-compilation
428 <ulink url='&YOCTO_DOCS_REF_URL;#var-PKG_CONFIG_PATH'><filename>PKG_CONFIG_PATH</filename></ulink> - The path to the target pkg-config files 427 <ulink url='&YOCTO_DOCS_REF_URL;#var-PKG_CONFIG_PATH'><filename>PKG_CONFIG_PATH</filename></ulink> - The path to the target pkg-config files
429 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_SITE'><filename>CONFIG_SITE</filename></ulink> - A GNU autoconf site file preconfigured for the target 428 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_SITE'><filename>CONFIG_SITE</filename></ulink> - A GNU autoconf site file preconfigured for the target
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 38a5a60a8a..e61f4c14e7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -9276,17 +9276,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9276 </glossdef> 9276 </glossdef>
9277 </glossentry> 9277 </glossentry>
9278 9278
9279 <glossentry id='var-SDKROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKROOT</glossterm>
9280 <info>
9281 SDKROOT[doc] = "The path to the installed SDK."
9282 </info>
9283 <glossdef>
9284 <para>
9285 Defines the path to the installed SDK.
9286 </para>
9287 </glossdef>
9288 </glossentry>
9289
9290 <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm> 9279 <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm>
9291 <info> 9280 <info>
9292 SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation." 9281 SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation."