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>
This commit is contained in:
Scott Rifenbark 2015-01-23 15:38:31 -08:00 committed by Richard Purdie
parent 93052c9900
commit b876909269
3 changed files with 16 additions and 19 deletions

View File

@ -210,19 +210,28 @@
<title>Makefile-Based Projects</title>
<para>
For Makefile-based projects, you make sure your
<filename>Makefile</filename> has statements that ensure proper
use of the cross-toolchain.
For example, the following statements inside a
<filename>Makefile</filename> ensure the C compiler, linker, flags
passed to the C compiler, and flags passed to the C++ compiler are
specifically defined for the build:
For Makefile-based projects, the cross-toolchain environment
variables established by running the cross-toolchain environment
setup script override any settings you might have in your
<filename>Makefile</filename>.
For example, if you had settings such as the following in your
<filename>Makefile</filename>, the environment variables defined
by the script would override them:
<literallayout class='monospaced'>
<ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=arm-poky-linux-gnueabi-gcc
<ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=arm-poky-linux-gnueabi-ld
<ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=”${CFLAGS} --sysroot=&lt;sysroot-dir&gt;
<ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=”${CXXFLAGS} --sysroot=&lt;sysroot-dir&gt;
</literallayout>
Consequently, you should not set variables like
<ulink url='&YOCTO_DOCS_REF_URL;#var-CC'><filename>CC</filename></ulink>
and
<ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink>
in your <filename>Makefile</filename>.
For the list of variables set up by the cross-toolchain environment
setup script, see the
"<link linkend='setting-up-the-cross-development-environment'>Setting Up the Cross-Development Environment</link>"
section.
</para>
</section>

View File

@ -423,7 +423,6 @@
When you run the setup script, many environment variables are
defined:
<literallayout class='monospaced'>
<ulink url='&YOCTO_DOCS_REF_URL;#var-SDKROOT'><filename>SDKROOT</filename></ulink> - The path to the installed SDK
<ulink url='&YOCTO_DOCS_REF_URL;#var-SDKTARGETSYSROOT'><filename>SDKTARGETSYSROOT</filename></ulink> - The path to the sysroot used for cross-compilation
<ulink url='&YOCTO_DOCS_REF_URL;#var-PKG_CONFIG_PATH'><filename>PKG_CONFIG_PATH</filename></ulink> - The path to the target pkg-config files
<ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_SITE'><filename>CONFIG_SITE</filename></ulink> - A GNU autoconf site file preconfigured for the target

View File

@ -9276,17 +9276,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-SDKROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKROOT</glossterm>
<info>
SDKROOT[doc] = "The path to the installed SDK."
</info>
<glossdef>
<para>
Defines the path to the installed SDK.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm>
<info>
SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation."