summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-01-23 07:40:15 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:55 +0000
commitce8ead36bbcd926c679a8e3cbb5ac759eb50beeb (patch)
treed7addf95a54f16a0e82a9fe3eec02f386c131e6b /documentation
parent9c27a91d611434bfa1029d0a783469dd9dbeef53 (diff)
downloadast2050-yocto-poky-ce8ead36bbcd926c679a8e3cbb5ac759eb50beeb.zip
ast2050-yocto-poky-ce8ead36bbcd926c679a8e3cbb5ac759eb50beeb.tar.gz
adt-manual, ref-manual: Added missing variables and cross-links
I added the ADKROOT, GDB, CROSS_COMPILE, and CONFIGURE_FLAGS variables to the glossary. Also added appropriate cross-reference links from the adt-manual to those new variables. (From yocto-docs rev: 812367e3b915b99d900b7934c4d5d409f393e814) 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-prepare.xml8
-rw-r--r--documentation/ref-manual/ref-variables.xml50
2 files changed, 53 insertions, 5 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 5c5bf39..995d589 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -423,7 +423,7 @@
When you run the setup script, many environment variables are
defined:
<literallayout class='monospaced'>
- <filename>SDKROOT</filename> - The path to the installed SDK
+ <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
@@ -432,7 +432,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-CPP'><filename>CPP</filename></ulink> - The minimal command and arguments to run the C preprocessor
<ulink url='&YOCTO_DOCS_REF_URL;#var-AS'><filename>AS</filename></ulink> - The minimal command and arguments to run the assembler
<ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink> - The minimal command and arguments to run the linker
- <filename>GDB</filename> - The minimal command and arguments to run the GNU Debugger
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-GDB'><filename>GDB</filename></ulink> - The minimal command and arguments to run the GNU Debugger
<ulink url='&YOCTO_DOCS_REF_URL;#var-STRIP'><filename>STRIP</filename></ulink> - The minimal command and arguments to run 'strip', which strips symbols
<ulink url='&YOCTO_DOCS_REF_URL;#var-RANLIB'><filename>RANLIB</filename></ulink> - The minimal command and arguments to run 'ranlib'
<ulink url='&YOCTO_DOCS_REF_URL;#var-OBJCOPY'><filename>OBJCOPY</filename></ulink> - The minimal command and arguments to run 'objcopy'
@@ -440,8 +440,8 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-AR'><filename>AR</filename></ulink> - The minimal command and arguments to run 'ar'
<ulink url='&YOCTO_DOCS_REF_URL;#var-NM'><filename>NM</filename></ulink> - The minimal command and arguments to run 'nm'
<ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></ulink> - The toolchain binary prefix for the target tools
- <filename>CROSS_COMPILE</filename> - The toolchain binary prefix for the target tools
- <filename>CONFIGURE_FLAGS</filename> - The minimal arguments for GNU configure
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-CROSS_COMPILE'><filename>CROSS_COMPILE</filename></ulink> - The toolchain binary prefix for the target tools
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS'><filename>CONFIGURE_FLAGS</filename></ulink> - The minimal arguments for GNU configure
<ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'><filename>CFLAGS</filename></ulink> - Suggested C flags
<ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'><filename>CXXFLAGS</filename></ulink> - Suggested C++ flags
<ulink url='&YOCTO_DOCS_REF_URL;#var-LDFLAGS'><filename>LDFLAGS</filename></ulink> - Suggested linker flags when you use CC to link
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 305176b..38a5a60 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -22,7 +22,7 @@
<link linkend='var-D'>D</link>
<link linkend='var-EFI_PROVIDER'>E</link>
<link linkend='var-FEATURE_PACKAGES'>F</link>
- <link linkend='var-GITDIR'>G</link>
+ <link linkend='var-GDB'>G</link>
<link linkend='var-HOMEPAGE'>H</link>
<link linkend='var-ICECC_DISABLED'>I</link>
<!-- <link linkend='var-glossary-j'>J</link> -->
@@ -1953,6 +1953,17 @@
</glossdef>
</glossentry>
+ <glossentry id='var-CONFIGURE_FLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CONFIGURE_FLAGS</glossterm>
+ <info>
+ CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure."
+ </info>
+ <glossdef>
+ <para>
+ The minimal arguments for GNU configure.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm><imagedata fileref="figures/define-generic.png" />CONFLICT_DISTRO_FEATURES</glossterm>
<info>
CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built."
@@ -2099,6 +2110,21 @@
</glossdef>
</glossentry>
+ <glossentry id='var-CROSS_COMPILE'><glossterm><imagedata fileref="figures/define-generic.png" />CROSS_COMPILE</glossterm>
+ <info>
+ CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools."
+ </info>
+ <glossdef>
+ <para>
+ The toolchain binary prefix for the target tools.
+ The <filename>CROSS_COMPILE</filename> variable is the
+ same as the
+ <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
+ variable.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-CVSDIR'><glossterm><imagedata fileref="figures/define-generic.png" />CVSDIR</glossterm>
<info>
CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
@@ -3674,6 +3700,17 @@
<glossdiv id='var-glossary-g'><title>G</title>
+ <glossentry id='var-GDB'><glossterm><imagedata fileref="figures/define-generic.png" />GDB</glossterm>
+ <info>
+ GDB[doc] = "The minimal command and arguments to run the GNU Debugger."
+ </info>
+ <glossdef>
+ <para>
+ The minimal command and arguments to run the GNU Debugger.
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-GITDIR'><glossterm><imagedata fileref="figures/define-generic.png" />GITDIR</glossterm>
<info>
GITDIR[doc] = "The directory where Git clones will be stored."
@@ -9239,6 +9276,17 @@ 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."
OpenPOWER on IntegriCloud