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: 67842df1a4a01f7bdd924027c66faf8f30c426ce)

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 2013-12-09 16:15:46 -06:00 committed by Richard Purdie
parent 84c76124a7
commit 122657979e
2 changed files with 7 additions and 56 deletions

View File

@ -914,17 +914,17 @@
native and cross compilers.
Depending on each configure or compile, the OpenEmbedded build system
adds the directories at the head of the <filename>PATH</filename> list
and then sets
<link linkend='var-ICECC_CXX'><filename>ICECC_CXX</filename></link>
and
<link linkend='var-ICECC_CC'><filename>ICEC_CC</filename></link>.
and then sets the <filename>ICECC_CXX</filename> and
<filename>ICEC_CC</filename> variables, which are the paths to the
<filename>g++</filename> and <filename>gcc</filename> compilers,
respectively.
</para>
<para>
For the cross compiler, the class creates a <filename>tar.gz</filename>
file that contains the Yocto Project toolchain and sets
<link linkend='var-ICECC_VERSION'><filename>ICECC_VERSION</filename></link>
accordingly.
<filename>ICECC_VERSION</filename>, which is the version of the
cross-compiler used in the cross-development toolchain, accordingly.
</para>
<para>

View File

@ -24,7 +24,7 @@
<link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link>
<link linkend='var-GROUPADD_PARAM'>G</link>
<link linkend='var-HOMEPAGE'>H</link>
<link linkend='var-ICECC_CC'>I</link>
<link linkend='var-ICECC_ENV_EXEC'>I</link>
<!-- <link linkend='var-glossary-j'>J</link> -->
<link linkend='var-KARCH'>K</link>
<link linkend='var-LABELS'>L</link>
@ -2334,42 +2334,6 @@
<glossdiv id='var-glossary-i'><title>I</title>
<glossentry id='var-ICECC_CC'><glossterm>ICECC_CC</glossterm>
<glossdef>
<para>
The path to the GNU C compiler <filename>gcc</filename>.
This variable is used by the
<link linkend='ref-classes-icecc'><filename>icecc</filename></link>
class.
You do not set this variable by hand.
</para>
<para>
When the location for the GNU C compiler is not a
symbolic link, the class sets the variable to the location
of the compiler.
</para>
</glossdef>
</glossentry>
<glossentry id='var-ICECC_CXX'><glossterm>ICECC_CXX</glossterm>
<glossdef>
<para>
The path to the GNU C++ compiler <filename>g++</filename>.
This variable is used by the
<link linkend='ref-classes-icecc'><filename>icecc</filename></link>
class.
You do not set this variable by hand.
</para>
<para>
When the location for the GNU C++ compiler is not a
symbolic link, the class sets the variable to the location
of the compiler.
</para>
</glossdef>
</glossentry>
<glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm>
<glossdef>
<para>
@ -2468,19 +2432,6 @@
</glossdef>
</glossentry>
<glossentry id='var-ICECC_VERSION'><glossterm>ICECC_VERSION</glossterm>
<glossdef>
<para>
The version of the cross-compiler used in the
cross-development toolchain.
This variable is used by the
<link linkend='ref-classes-icecc'><filename>icecc</filename></link>
class.
You do not set this variable by hand.
</para>
</glossdef>
</glossentry>
<glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
<glossdef>
<para>