summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-13 10:18:08 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-09-22 12:20:43 +0100
commit599209eca2d54ae1febcb0fc006116c281642e0b (patch)
tree0b0bef4972fa1ed95e2a6f20ace12a052d7d9b9e
parent053ee260a868a6698a7b52ee187ac2d7039b4a95 (diff)
downloadpoky-599209eca2d54ae1febcb0fc006116c281642e0b.tar.gz
ref-manual: Added three new variable descriptions to the glossary
PATCHRESOLVE IMAGE_CLASSES USER_CLASSES (From yocto-docs rev: 369a2d92b69fa68be7dfa989d1148f694b84661a) 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-variables.xml82
1 files changed, 78 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index e17895f73c..38e7f464a0 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -24,7 +24,7 @@
24 <link linkend='var-FILES'>F</link> 24 <link linkend='var-FILES'>F</link>
25<!-- <link linkend='var-glossary-g'>G</link> --> 25<!-- <link linkend='var-glossary-g'>G</link> -->
26 <link linkend='var-HOMEPAGE'>H</link> 26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-IMAGE_FEATURES'>I</link> 27 <link linkend='var-IMAGE_CLASSES'>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-LAYERDEPENDS'>L</link> 30 <link linkend='var-LAYERDEPENDS'>L</link>
@@ -36,7 +36,7 @@
36 <link linkend='var-RCONFLICTS'>R</link> 36 <link linkend='var-RCONFLICTS'>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-glossary-u'>U</link> --> 39 <link linkend='var-USER_CLASSES'>U</link>
40<!-- <link linkend='var-glossary-v'>V</link> --> 40<!-- <link linkend='var-glossary-v'>V</link> -->
41 <link linkend='var-WARN_QA'>W</link> 41 <link linkend='var-WARN_QA'>W</link>
42<!-- <link linkend='var-glossary-x'>X</link> --> 42<!-- <link linkend='var-glossary-x'>X</link> -->
@@ -1798,6 +1798,31 @@ Core layer for images cannot be removed
1798 1798
1799 <glossdiv id='var-glossary-i'><title>I</title> 1799 <glossdiv id='var-glossary-i'><title>I</title>
1800 1800
1801 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
1802 <glossdef>
1803 <para>
1804 A list of classes that all images should inherit.
1805 You typically use this variable to specify the list of
1806 classes that register the different types of images
1807 the OpenEmbedded build system creates.
1808 </para>
1809
1810 <para>
1811 The default value for <filename>IMAGE_CLASSES</filename> is
1812 <filename>image_types.bbclass</filename>.
1813 You can set this variable in your
1814 <filename>local.conf</filename> or in a distribution
1815 configuration file.
1816 </para>
1817
1818 <para>
1819 For more information, see
1820 <filename>meta/classes/image_types.bbclass</filename> in the
1821 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1822 </para>
1823 </glossdef>
1824 </glossentry>
1825
1801 <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> 1826 <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
1802 <glossdef> 1827 <glossdef>
1803 <para> 1828 <para>
@@ -3651,6 +3676,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3651 </glossdef> 3676 </glossdef>
3652 </glossentry> 3677 </glossentry>
3653 3678
3679 <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm>
3680 <glossdef>
3681 <para>
3682 Determines the action to take when a patch fails.
3683 You can set this variable to one of two values: "noop" and
3684 "user".
3685 </para>
3686
3687 <para>
3688 The default value of "noop" causes the build to simply fail
3689 when the OpenEmbedded build system cannot successfully
3690 apply a patch.
3691 Setting the value to "user" causes the build system to
3692 launch a shell and places you in the right location so that
3693 you can manually resolve the conflicts.
3694 </para>
3695
3696 <para>
3697 Set this variable in your
3698 <filename>local.conf</filename> file.
3699 </para>
3700 </glossdef>
3701 </glossentry>
3702
3654 <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm> 3703 <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm>
3655 <glossdef> 3704 <glossdef>
3656 <para> 3705 <para>
@@ -5075,8 +5124,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5075 5124
5076 </glossdiv> 5125 </glossdiv>
5077 5126
5078<!-- <glossdiv id='var-glossary-u'><title>U</title>--> 5127 <glossdiv id='var-glossary-u'><title>U</title>
5079<!-- </glossdiv>--> 5128
5129 <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm>
5130 <glossdef>
5131 <para>
5132 A list of classes to globally inherit.
5133 These classes are used by the OpenEmbedded build system
5134 to enable extra features (e.g.
5135 <filename>buildstats</filename>,
5136 <filename>image-mklibs</filename>, and so forth).
5137 </para>
5138
5139 <para>
5140 The default list is set in your
5141 <filename>local.conf</filename> file:
5142 <literallayout class='monospaced'>
5143 USER_CLASSES ?= "buildstats image-mklibs image-prelink"
5144 </literallayout>
5145 For more information, see
5146 <filename>meta-yocto/conf/local.conf.sample</filename> in
5147 the
5148 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
5149 </para>
5150 </glossdef>
5151 </glossentry>
5152
5153 </glossdiv>
5080 5154
5081<!-- <glossdiv id='var-glossary-v'><title>V</title>--> 5155<!-- <glossdiv id='var-glossary-v'><title>V</title>-->
5082<!-- </glossdiv>--> 5156<!-- </glossdiv>-->