summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-09 16:15:46 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-11 14:19:31 +0000
commitb361db086807bc9c72b8a88b0d3f78c0f83399b2 (patch)
tree6c5f75e02859af2b716e101b162ac95b4aa3081c
parent88fb980b5e3023410c18b314533fd9b2db94d2a5 (diff)
downloadpoky-b361db086807bc9c72b8a88b0d3f78c0f83399b2.tar.gz
ref-manual: Edits to icecc class and removal of three variables.
Fixed the links in the icecc class that linked into ICECC_CC, ICECC_CXX, and ICECC_VERSION so they don't link anymore but rather give a very brief explanation of what the variable does. Removed the above three variables from the variable glossary. These are not BitBake variables and we should not document them. (From yocto-docs rev: f4f79d27c0d1417ff683381f18f165cda3a8a02e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml12
-rw-r--r--documentation/ref-manual/ref-variables.xml51
2 files changed, 7 insertions, 56 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index a219a930b9..bd4f8629da 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -914,17 +914,17 @@
914 native and cross compilers. 914 native and cross compilers.
915 Depending on each configure or compile, the OpenEmbedded build system 915 Depending on each configure or compile, the OpenEmbedded build system
916 adds the directories at the head of the <filename>PATH</filename> list 916 adds the directories at the head of the <filename>PATH</filename> list
917 and then sets 917 and then sets the <filename>ICECC_CXX</filename> and
918 <link linkend='var-ICECC_CXX'><filename>ICECC_CXX</filename></link> 918 <filename>ICEC_CC</filename> variables, which are the paths to the
919 and 919 <filename>g++</filename> and <filename>gcc</filename> compilers,
920 <link linkend='var-ICECC_CC'><filename>ICEC_CC</filename></link>. 920 respectively.
921 </para> 921 </para>
922 922
923 <para> 923 <para>
924 For the cross compiler, the class creates a <filename>tar.gz</filename> 924 For the cross compiler, the class creates a <filename>tar.gz</filename>
925 file that contains the Yocto Project toolchain and sets 925 file that contains the Yocto Project toolchain and sets
926 <link linkend='var-ICECC_VERSION'><filename>ICECC_VERSION</filename></link> 926 <filename>ICECC_VERSION</filename>, which is the version of the
927 accordingly. 927 cross-compiler used in the cross-development toolchain, accordingly.
928 </para> 928 </para>
929 929
930 <para> 930 <para>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 43829a6607..736dde2d57 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -24,7 +24,7 @@
24 <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link> 24 <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link>
25 <link linkend='var-GROUPADD_PARAM'>G</link> 25 <link linkend='var-GROUPADD_PARAM'>G</link>
26 <link linkend='var-HOMEPAGE'>H</link> 26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-ICECC_CC'>I</link> 27 <link linkend='var-ICECC_ENV_EXEC'>I</link>
28<!-- <link linkend='var-glossary-j'>J</link> --> 28<!-- <link linkend='var-glossary-j'>J</link> -->
29 <link linkend='var-KARCH'>K</link> 29 <link linkend='var-KARCH'>K</link>
30 <link linkend='var-LABELS'>L</link> 30 <link linkend='var-LABELS'>L</link>
@@ -2334,42 +2334,6 @@
2334 2334
2335 <glossdiv id='var-glossary-i'><title>I</title> 2335 <glossdiv id='var-glossary-i'><title>I</title>
2336 2336
2337 <glossentry id='var-ICECC_CC'><glossterm>ICECC_CC</glossterm>
2338 <glossdef>
2339 <para>
2340 The path to the GNU C compiler <filename>gcc</filename>.
2341 This variable is used by the
2342 <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
2343 class.
2344 You do not set this variable by hand.
2345 </para>
2346
2347 <para>
2348 When the location for the GNU C compiler is not a
2349 symbolic link, the class sets the variable to the location
2350 of the compiler.
2351 </para>
2352 </glossdef>
2353 </glossentry>
2354
2355 <glossentry id='var-ICECC_CXX'><glossterm>ICECC_CXX</glossterm>
2356 <glossdef>
2357 <para>
2358 The path to the GNU C++ compiler <filename>g++</filename>.
2359 This variable is used by the
2360 <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
2361 class.
2362 You do not set this variable by hand.
2363 </para>
2364
2365 <para>
2366 When the location for the GNU C++ compiler is not a
2367 symbolic link, the class sets the variable to the location
2368 of the compiler.
2369 </para>
2370 </glossdef>
2371 </glossentry>
2372
2373 <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm> 2337 <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm>
2374 <glossdef> 2338 <glossdef>
2375 <para> 2339 <para>
@@ -2468,19 +2432,6 @@
2468 </glossdef> 2432 </glossdef>
2469 </glossentry> 2433 </glossentry>
2470 2434
2471 <glossentry id='var-ICECC_VERSION'><glossterm>ICECC_VERSION</glossterm>
2472 <glossdef>
2473 <para>
2474 The version of the cross-compiler used in the
2475 cross-development toolchain.
2476 This variable is used by the
2477 <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
2478 class.
2479 You do not set this variable by hand.
2480 </para>
2481 </glossdef>
2482 </glossentry>
2483
2484 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> 2435 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
2485 <glossdef> 2436 <glossdef>
2486 <para> 2437 <para>