summaryrefslogtreecommitdiffstats
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
parent9c27a91d611434bfa1029d0a783469dd9dbeef53 (diff)
downloadpoky-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>
-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 5c5bf396c2..995d589219 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -423,7 +423,7 @@
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 <filename>SDKROOT</filename> - The path to the installed SDK 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 427 <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 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
429 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_SITE'><filename>CONFIG_SITE</filename></ulink> - A GNU autoconf site file preconfigured for the target 429 <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 @@
432 <ulink url='&YOCTO_DOCS_REF_URL;#var-CPP'><filename>CPP</filename></ulink> - The minimal command and arguments to run the C preprocessor 432 <ulink url='&YOCTO_DOCS_REF_URL;#var-CPP'><filename>CPP</filename></ulink> - The minimal command and arguments to run the C preprocessor
433 <ulink url='&YOCTO_DOCS_REF_URL;#var-AS'><filename>AS</filename></ulink> - The minimal command and arguments to run the assembler 433 <ulink url='&YOCTO_DOCS_REF_URL;#var-AS'><filename>AS</filename></ulink> - The minimal command and arguments to run the assembler
434 <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink> - The minimal command and arguments to run the linker 434 <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink> - The minimal command and arguments to run the linker
435 <filename>GDB</filename> - The minimal command and arguments to run the GNU Debugger 435 <ulink url='&YOCTO_DOCS_REF_URL;#var-GDB'><filename>GDB</filename></ulink> - The minimal command and arguments to run the GNU Debugger
436 <ulink url='&YOCTO_DOCS_REF_URL;#var-STRIP'><filename>STRIP</filename></ulink> - The minimal command and arguments to run 'strip', which strips symbols 436 <ulink url='&YOCTO_DOCS_REF_URL;#var-STRIP'><filename>STRIP</filename></ulink> - The minimal command and arguments to run 'strip', which strips symbols
437 <ulink url='&YOCTO_DOCS_REF_URL;#var-RANLIB'><filename>RANLIB</filename></ulink> - The minimal command and arguments to run 'ranlib' 437 <ulink url='&YOCTO_DOCS_REF_URL;#var-RANLIB'><filename>RANLIB</filename></ulink> - The minimal command and arguments to run 'ranlib'
438 <ulink url='&YOCTO_DOCS_REF_URL;#var-OBJCOPY'><filename>OBJCOPY</filename></ulink> - The minimal command and arguments to run 'objcopy' 438 <ulink url='&YOCTO_DOCS_REF_URL;#var-OBJCOPY'><filename>OBJCOPY</filename></ulink> - The minimal command and arguments to run 'objcopy'
@@ -440,8 +440,8 @@
440 <ulink url='&YOCTO_DOCS_REF_URL;#var-AR'><filename>AR</filename></ulink> - The minimal command and arguments to run 'ar' 440 <ulink url='&YOCTO_DOCS_REF_URL;#var-AR'><filename>AR</filename></ulink> - The minimal command and arguments to run 'ar'
441 <ulink url='&YOCTO_DOCS_REF_URL;#var-NM'><filename>NM</filename></ulink> - The minimal command and arguments to run 'nm' 441 <ulink url='&YOCTO_DOCS_REF_URL;#var-NM'><filename>NM</filename></ulink> - The minimal command and arguments to run 'nm'
442 <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></ulink> - The toolchain binary prefix for the target tools 442 <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></ulink> - The toolchain binary prefix for the target tools
443 <filename>CROSS_COMPILE</filename> - The toolchain binary prefix for the target tools 443 <ulink url='&YOCTO_DOCS_REF_URL;#var-CROSS_COMPILE'><filename>CROSS_COMPILE</filename></ulink> - The toolchain binary prefix for the target tools
444 <filename>CONFIGURE_FLAGS</filename> - The minimal arguments for GNU configure 444 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS'><filename>CONFIGURE_FLAGS</filename></ulink> - The minimal arguments for GNU configure
445 <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'><filename>CFLAGS</filename></ulink> - Suggested C flags 445 <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'><filename>CFLAGS</filename></ulink> - Suggested C flags
446 <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'><filename>CXXFLAGS</filename></ulink> - Suggested C++ flags 446 <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'><filename>CXXFLAGS</filename></ulink> - Suggested C++ flags
447 <ulink url='&YOCTO_DOCS_REF_URL;#var-LDFLAGS'><filename>LDFLAGS</filename></ulink> - Suggested linker flags when you use CC to link 447 <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 305176bf2c..38a5a60a8a 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -22,7 +22,7 @@
22 <link linkend='var-D'>D</link> 22 <link linkend='var-D'>D</link>
23 <link linkend='var-EFI_PROVIDER'>E</link> 23 <link linkend='var-EFI_PROVIDER'>E</link>
24 <link linkend='var-FEATURE_PACKAGES'>F</link> 24 <link linkend='var-FEATURE_PACKAGES'>F</link>
25 <link linkend='var-GITDIR'>G</link> 25 <link linkend='var-GDB'>G</link>
26 <link linkend='var-HOMEPAGE'>H</link> 26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-ICECC_DISABLED'>I</link> 27 <link linkend='var-ICECC_DISABLED'>I</link>
28<!-- <link linkend='var-glossary-j'>J</link> --> 28<!-- <link linkend='var-glossary-j'>J</link> -->
@@ -1953,6 +1953,17 @@
1953 </glossdef> 1953 </glossdef>
1954 </glossentry> 1954 </glossentry>
1955 1955
1956 <glossentry id='var-CONFIGURE_FLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CONFIGURE_FLAGS</glossterm>
1957 <info>
1958 CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure."
1959 </info>
1960 <glossdef>
1961 <para>
1962 The minimal arguments for GNU configure.
1963 </para>
1964 </glossdef>
1965 </glossentry>
1966
1956 <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm><imagedata fileref="figures/define-generic.png" />CONFLICT_DISTRO_FEATURES</glossterm> 1967 <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm><imagedata fileref="figures/define-generic.png" />CONFLICT_DISTRO_FEATURES</glossterm>
1957 <info> 1968 <info>
1958 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." 1969 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 @@
2099 </glossdef> 2110 </glossdef>
2100 </glossentry> 2111 </glossentry>
2101 2112
2113 <glossentry id='var-CROSS_COMPILE'><glossterm><imagedata fileref="figures/define-generic.png" />CROSS_COMPILE</glossterm>
2114 <info>
2115 CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools."
2116 </info>
2117 <glossdef>
2118 <para>
2119 The toolchain binary prefix for the target tools.
2120 The <filename>CROSS_COMPILE</filename> variable is the
2121 same as the
2122 <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
2123 variable.
2124 </para>
2125 </glossdef>
2126 </glossentry>
2127
2102 <glossentry id='var-CVSDIR'><glossterm><imagedata fileref="figures/define-generic.png" />CVSDIR</glossterm> 2128 <glossentry id='var-CVSDIR'><glossterm><imagedata fileref="figures/define-generic.png" />CVSDIR</glossterm>
2103 <info> 2129 <info>
2104 CVSDIR[doc] = "The directory where cvs checkouts will be stored in." 2130 CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
@@ -3674,6 +3700,17 @@
3674 3700
3675 <glossdiv id='var-glossary-g'><title>G</title> 3701 <glossdiv id='var-glossary-g'><title>G</title>
3676 3702
3703 <glossentry id='var-GDB'><glossterm><imagedata fileref="figures/define-generic.png" />GDB</glossterm>
3704 <info>
3705 GDB[doc] = "The minimal command and arguments to run the GNU Debugger."
3706 </info>
3707 <glossdef>
3708 <para>
3709 The minimal command and arguments to run the GNU Debugger.
3710 </para>
3711 </glossdef>
3712 </glossentry>
3713
3677 <glossentry id='var-GITDIR'><glossterm><imagedata fileref="figures/define-generic.png" />GITDIR</glossterm> 3714 <glossentry id='var-GITDIR'><glossterm><imagedata fileref="figures/define-generic.png" />GITDIR</glossterm>
3678 <info> 3715 <info>
3679 GITDIR[doc] = "The directory where Git clones will be stored." 3716 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"
9239 </glossdef> 9276 </glossdef>
9240 </glossentry> 9277 </glossentry>
9241 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
9242 <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm> 9290 <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm>
9243 <info> 9291 <info>
9244 SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation." 9292 SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation."