summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-01-20 13:41:01 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:16:52 +0000
commit70a2007b6768a6c535f101e5fdde28210929455f (patch)
tree39f7c0c5c272524141627cdb05530aac6a945f60 /documentation/ref-manual/ref-variables.xml
parenteafdfbfb37df55198dbefbdf665737cb22fb2106 (diff)
downloadpoky-70a2007b6768a6c535f101e5fdde28210929455f.tar.gz
ref-manual: New variables added to the variable glossary
Fixes [YOCTO #7133] This goes toward fixing the bug but not completing it. I have added the following variables to the variable glossary: SDKTARGETSYSROOT PKG_CONFIG_PATH CC CXX CPP AS LD TARGET_PREFIX AR STRIP OBJCOPY OBJDUMP RANLIB NM (From yocto-docs rev: c9d9e422684dad7cdc81db309235d0d1751ac88a) 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/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml173
1 files changed, 170 insertions, 3 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 85803ef89d..3511f38855 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -18,7 +18,7 @@
18 <para> 18 <para>
19 <link linkend='var-ABIEXTENSION'>A</link> 19 <link linkend='var-ABIEXTENSION'>A</link>
20 <link linkend='var-B'>B</link> 20 <link linkend='var-B'>B</link>
21 <link linkend='var-CFLAGS'>C</link> 21 <link linkend='var-CC'>C</link>
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>
@@ -30,10 +30,10 @@
30 <link linkend='var-LABELS'>L</link> 30 <link linkend='var-LABELS'>L</link>
31 <link linkend='var-MACHINE'>M</link> 31 <link linkend='var-MACHINE'>M</link>
32<!-- <link linkend='var-glossary-n'>N</link> --> 32<!-- <link linkend='var-glossary-n'>N</link> -->
33 <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link> 33 <link linkend='var-OBJCOPY'>O</link>
34 <link linkend='var-P'>P</link> 34 <link linkend='var-P'>P</link>
35 <link linkend='var-QMAKE_PROFILES'>Q</link> 35 <link linkend='var-QMAKE_PROFILES'>Q</link>
36 <link linkend='var-RCONFLICTS'>R</link> 36 <link linkend='var-RANLIB'>R</link>
37 <link linkend='var-S'>S</link> 37 <link linkend='var-S'>S</link>
38 <link linkend='var-T'>T</link> 38 <link linkend='var-T'>T</link>
39 <link linkend='var-UBOOT_CONFIG'>U</link> 39 <link linkend='var-UBOOT_CONFIG'>U</link>
@@ -260,6 +260,30 @@
260 </glossdef> 260 </glossdef>
261 </glossentry> 261 </glossentry>
262 262
263 <glossentry id='var-AR'><glossterm><imagedata fileref="figures/define-generic.png" />AR</glossterm>
264 <info>
265 AR[doc] = "Minimal command and arguments to run 'ar'."
266 </info>
267 <glossdef>
268 <para>
269 The minimal command and arguments used to run
270 <filename>ar</filename>.
271 </para>
272 </glossdef>
273 </glossentry>
274
275 <glossentry id='var-AS'><glossterm><imagedata fileref="figures/define-generic.png" />AS</glossterm>
276 <info>
277 AS[doc] = "Minimal command and arguments to run the assembler."
278 </info>
279 <glossdef>
280 <para>
281 The minimal command and arguments used to run the
282 assembler.
283 </para>
284 </glossdef>
285 </glossentry>
286
263 <glossentry id='var-ASSUME_PROVIDED'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_PROVIDED</glossterm> 287 <glossentry id='var-ASSUME_PROVIDED'><glossterm><imagedata fileref="figures/define-generic.png" />ASSUME_PROVIDED</glossterm>
264 <info> 288 <info>
265 ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build." 289 ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build."
@@ -1545,6 +1569,18 @@
1545 1569
1546 <glossdiv id='var-glossary-c'><title>C</title> 1570 <glossdiv id='var-glossary-c'><title>C</title>
1547 1571
1572 <glossentry id='var-CC'><glossterm><imagedata fileref="figures/define-generic.png" />CC</glossterm>
1573 <info>
1574 CC[doc] = "Minimum command and arguments to run the C compiler."
1575 </info>
1576 <glossdef>
1577 <para>
1578 The minimal command and arguments used to run the C
1579 compiler.
1580 </para>
1581 </glossdef>
1582 </glossentry>
1583
1548 <glossentry id='var-CFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CFLAGS</glossterm> 1584 <glossentry id='var-CFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CFLAGS</glossterm>
1549 <info> 1585 <info>
1550 CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS." 1586 CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS."
@@ -1938,6 +1974,18 @@
1938 </glossdef> 1974 </glossdef>
1939 </glossentry> 1975 </glossentry>
1940 1976
1977 <glossentry id='var-CPP'><glossterm><imagedata fileref="figures/define-generic.png" />CPP</glossterm>
1978 <info>
1979 CPP[doc] = "Minimum command and arguments to run the C preprocessor."
1980 </info>
1981 <glossdef>
1982 <para>
1983 The minimal command and arguments used to run the C
1984 preprocessor.
1985 </para>
1986 </glossdef>
1987 </glossentry>
1988
1941 <glossentry id='var-CPPFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CPPFLAGS</glossterm> 1989 <glossentry id='var-CPPFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CPPFLAGS</glossterm>
1942 <info> 1990 <info>
1943 CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)." 1991 CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)."
@@ -1974,6 +2022,18 @@
1974 </glossdef> 2022 </glossdef>
1975 </glossentry> 2023 </glossentry>
1976 2024
2025 <glossentry id='var-CXX'><glossterm><imagedata fileref="figures/define-generic.png" />CXX</glossterm>
2026 <info>
2027 CXX[doc] = "Minimum command and arguments to run the C++ compiler."
2028 </info>
2029 <glossdef>
2030 <para>
2031 The minimal command and arguments used to run the C++
2032 compiler.
2033 </para>
2034 </glossdef>
2035 </glossentry>
2036
1977 <glossentry id='var-CXXFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CXXFLAGS</glossterm> 2037 <glossentry id='var-CXXFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />CXXFLAGS</glossterm>
1978 <info> 2038 <info>
1979 CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler." 2039 CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler."
@@ -5730,6 +5790,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5730 </glossdef> 5790 </glossdef>
5731 </glossentry> 5791 </glossentry>
5732 5792
5793 <glossentry id='var-LD'><glossterm><imagedata fileref="figures/define-generic.png" />LD</glossterm>
5794 <info>
5795 LD[doc] = "Minimal command and arguments to run the linker."
5796 </info>
5797 <glossdef>
5798 <para>
5799 The minimal command and arguments used to run the
5800 linker.
5801 </para>
5802 </glossdef>
5803 </glossentry>
5804
5733 <glossentry id='var-LDFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />LDFLAGS</glossterm> 5805 <glossentry id='var-LDFLAGS'><glossterm><imagedata fileref="figures/define-generic.png" />LDFLAGS</glossterm>
5734 <info> 5806 <info>
5735 LDFLAGS[doc] = "Specifies the flags to pass to the linker." 5807 LDFLAGS[doc] = "Specifies the flags to pass to the linker."
@@ -6595,6 +6667,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6595 </glossdef> 6667 </glossdef>
6596 </glossentry> 6668 </glossentry>
6597 6669
6670 <glossentry id='var-NM'><glossterm><imagedata fileref="figures/define-generic.png" />NM</glossterm>
6671 <info>
6672 NM[doc] = "Minimal command and arguments to run 'nm'."
6673 </info>
6674 <glossdef>
6675 <para>
6676 The minimal command and arguments to run
6677 <filename>nm</filename>.
6678 </para>
6679 </glossdef>
6680 </glossentry>
6681
6598 <glossentry id='var-NO_RECOMMENDATIONS'><glossterm><imagedata fileref="figures/define-generic.png" />NO_RECOMMENDATIONS</glossterm> 6682 <glossentry id='var-NO_RECOMMENDATIONS'><glossterm><imagedata fileref="figures/define-generic.png" />NO_RECOMMENDATIONS</glossterm>
6599 <info> 6683 <info>
6600 NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." 6684 NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed."
@@ -6691,6 +6775,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6691 6775
6692 <glossdiv id='var-glossary-o'><title>O</title> 6776 <glossdiv id='var-glossary-o'><title>O</title>
6693 6777
6778 <glossentry id='var-OBJCOPY'><glossterm><imagedata fileref="figures/define-generic.png" />OBJCOPY</glossterm>
6779 <info>
6780 OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'."
6781 </info>
6782 <glossdef>
6783 <para>
6784 The minimal command and arguments to run
6785 <filename>objcopy</filename>.
6786 </para>
6787 </glossdef>
6788 </glossentry>
6789
6790 <glossentry id='var-OBJDUMP'><glossterm><imagedata fileref="figures/define-generic.png" />OBJDUMP</glossterm>
6791 <info>
6792 OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'."
6793 </info>
6794 <glossdef>
6795 <para>
6796 The minimal command and arguments to run
6797 <filename>objdump</filename>.
6798 </para>
6799 </glossdef>
6800 </glossentry>
6801
6694 <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm><imagedata fileref="figures/define-generic.png" />OE_BINCONFIG_EXTRA_MANGLE</glossterm> 6802 <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm><imagedata fileref="figures/define-generic.png" />OE_BINCONFIG_EXTRA_MANGLE</glossterm>
6695 <info> 6803 <info>
6696 OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command." 6804 OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command."
@@ -7538,6 +7646,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7538 </glossdef> 7646 </glossdef>
7539 </glossentry> 7647 </glossentry>
7540 7648
7649 <glossentry id='var-PKG_CONFIG_PATH'><glossterm><imagedata fileref="figures/define-generic.png" />PKG_CONFIG_PATH</glossterm>
7650 <info>
7651 PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the target."
7652 </info>
7653 <glossdef>
7654 <para>
7655 The path to <filename>pkg-config</filename> files for the
7656 target.
7657 </para>
7658 </glossdef>
7659 </glossentry>
7660
7541 <glossentry id='var-PKGD'><glossterm><imagedata fileref="figures/define-generic.png" />PKGD</glossterm> 7661 <glossentry id='var-PKGD'><glossterm><imagedata fileref="figures/define-generic.png" />PKGD</glossterm>
7542 <info> 7662 <info>
7543 PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages." 7663 PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages."
@@ -8109,6 +8229,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8109 8229
8110 <glossdiv id='var-glossary-r'><title>R</title> 8230 <glossdiv id='var-glossary-r'><title>R</title>
8111 8231
8232 <glossentry id='var-RANLIB'><glossterm><imagedata fileref="figures/define-generic.png" />RANLIB</glossterm>
8233 <info>
8234 RANLIB[doc] = "Minimal command and arguments to run 'ranlib'."
8235 </info>
8236 <glossdef>
8237 <para>
8238 The minimal command and arguments to run
8239 <filename>ranlib</filename>.
8240 </para>
8241 </glossdef>
8242 </glossentry>
8243
8112 <glossentry id='var-RCONFLICTS'><glossterm><imagedata fileref="figures/define-generic.png" />RCONFLICTS</glossterm> 8244 <glossentry id='var-RCONFLICTS'><glossterm><imagedata fileref="figures/define-generic.png" />RCONFLICTS</glossterm>
8113 <info> 8245 <info>
8114 RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed." 8246 RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed."
@@ -8891,6 +9023,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8891 </glossdef> 9023 </glossdef>
8892 </glossentry> 9024 </glossentry>
8893 9025
9026 <glossentry id='var-SDKTARGETSYSROOT'><glossterm><imagedata fileref="figures/define-generic.png" />SDKTARGETSYSROOT</glossterm>
9027 <info>
9028 SDKTARGETSYSROOT[doc] = "Path to the sysroot used for cross-compilation."
9029 </info>
9030 <glossdef>
9031 <para>
9032 The path to the sysroot used for cross-compilation.
9033 </para>
9034 </glossdef>
9035 </glossentry>
9036
8894 <glossentry id='var-SECTION'><glossterm><imagedata fileref="figures/define-generic.png" />SECTION</glossterm> 9037 <glossentry id='var-SECTION'><glossterm><imagedata fileref="figures/define-generic.png" />SECTION</glossterm>
8895 <info> 9038 <info>
8896 SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable." 9039 SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable."
@@ -9827,6 +9970,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9827 </glossdef> 9970 </glossdef>
9828 </glossentry> 9971 </glossentry>
9829 9972
9973 <glossentry id='var-STRIP'><glossterm><imagedata fileref="figures/define-generic.png" />STRIP</glossterm>
9974 <info>
9975 STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)."
9976 </info>
9977 <glossdef>
9978 <para>
9979 The minimal command and arguments to run
9980 <filename>strip</filename>, which is used to strip
9981 symbols.
9982 </para>
9983 </glossdef>
9984 </glossentry>
9985
9830 <glossentry id='var-SUMMARY'><glossterm><imagedata fileref="figures/define-generic.png" />SUMMARY</glossterm> 9986 <glossentry id='var-SUMMARY'><glossterm><imagedata fileref="figures/define-generic.png" />SUMMARY</glossterm>
9831 <info> 9987 <info>
9832 SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." 9988 SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe."
@@ -10327,6 +10483,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10327 </glossdef> 10483 </glossdef>
10328 </glossentry> 10484 </glossentry>
10329 10485
10486 <glossentry id='var-TARGET_PREFIX'><glossterm><imagedata fileref="figures/define-generic.png" />TARGET_PREFIX</glossterm>
10487 <info>
10488 TARGET_PREFIX[doc] = "Toolchain binary prefix for the target tools."
10489 </info>
10490 <glossdef>
10491 <para>
10492 The toolchain binary prefix for the target tools.
10493 </para>
10494 </glossdef>
10495 </glossentry>
10496
10330 <glossentry id='var-TCLIBCAPPEND'><glossterm><imagedata fileref="figures/define-generic.png" />TCLIBCAPPEND</glossterm> 10497 <glossentry id='var-TCLIBCAPPEND'><glossterm><imagedata fileref="figures/define-generic.png" />TCLIBCAPPEND</glossterm>
10331 <info> 10498 <info>
10332 TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." 10499 TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build."