ref-varlocality.xml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  3. <appendix id='ref-varlocality'>
  4. <title>Reference: Variable Locality (Distro, Machine, Recipe etc.)</title>
  5. <para>
  6. Whilst most variables can be used in almost any context (.conf, .bbclass,
  7. .inc or .bb file), variables are often associated with a particular
  8. locality/context. This section describes some common associations.
  9. </para>
  10. <section id='ref-varlocality-config-distro'>
  11. <title>Distro Configuration</title>
  12. <itemizedlist>
  13. <listitem>
  14. <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
  15. </listitem>
  16. <listitem>
  17. <para><glossterm linkend='var-DISTRO_NAME'><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></glossterm></para>
  18. </listitem>
  19. <listitem>
  20. <para><glossterm linkend='var-DISTRO_VERSION'><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link></glossterm></para>
  21. </listitem>
  22. <listitem>
  23. <para><glossterm linkend='var-MAINTAINER'><link linkend='var-MAINTAINER'>MAINTAINER</link></glossterm></para>
  24. </listitem>
  25. <listitem>
  26. <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
  27. </listitem>
  28. <listitem>
  29. <para><glossterm linkend='var-TARGET_OS'><link linkend='var-TARGET_OS'>TARGET_OS</link></glossterm></para>
  30. </listitem>
  31. <listitem>
  32. <para><glossterm linkend='var-TARGET_FPU'><link linkend='var-TARGET_FPU'>TARGET_FPU</link></glossterm></para>
  33. </listitem>
  34. <listitem>
  35. <para><glossterm linkend='var-POKYMODE'><link linkend='var-POKYMODE'>POKYMODE</link></glossterm></para>
  36. </listitem>
  37. <listitem>
  38. <para><glossterm linkend='var-POKYLIBC'><link linkend='var-POKYLIBC'>POKYLIBC</link></glossterm></para>
  39. </listitem>
  40. </itemizedlist>
  41. </section>
  42. <section id='ref-varlocality-config-machine'>
  43. <title>Machine Configuration</title>
  44. <itemizedlist>
  45. <listitem>
  46. <para><glossterm linkend='var-TARGET_ARCH'><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></glossterm></para>
  47. </listitem>
  48. <listitem>
  49. <para><glossterm linkend='var-SERIAL_CONSOLE'><link linkend='var-SERIAL_CONSOLE'>SERIAL_CONSOLE</link></glossterm></para>
  50. </listitem>
  51. <listitem>
  52. <para><glossterm linkend='var-PACKAGE_EXTRA_ARCHS'><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link></glossterm></para>
  53. </listitem>
  54. <listitem>
  55. <para><glossterm linkend='var-IMAGE_FSTYPES'><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></glossterm></para>
  56. </listitem>
  57. <listitem>
  58. <para><glossterm linkend='var-ROOT_FLASH_SIZE'><link linkend='var-ROOT_FLASH_SIZE'>ROOT_FLASH_SIZE</link></glossterm></para>
  59. </listitem>
  60. <listitem>
  61. <para><glossterm linkend='var-MACHINE_FEATURES'><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm></para>
  62. </listitem>
  63. <listitem>
  64. <para><glossterm linkend='var-MACHINE_EXTRA_RDEPENDS'><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></glossterm></para>
  65. </listitem>
  66. <listitem>
  67. <para><glossterm linkend='var-MACHINE_EXTRA_RRECOMMENDS'><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></glossterm></para>
  68. </listitem>
  69. <listitem>
  70. <para><glossterm linkend='var-MACHINE_ESSENTIAL_RDEPENDS'><link linkend='var-MACHINE_ESSENTIAL_RDEPENDS'>MACHINE_ESSENTIAL_RDEPENDS</link></glossterm></para>
  71. </listitem>
  72. <listitem>
  73. <para><glossterm linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'><link linkend='var-MACHINE_ESSENTIAL_RRECOMMENDS'>MACHINE_ESSENTIAL_RRECOMMENDS</link></glossterm></para>
  74. </listitem>
  75. </itemizedlist>
  76. </section>
  77. <section id='ref-varlocality-config-local'>
  78. <title>Local Configuration (local.conf)</title>
  79. <itemizedlist>
  80. <listitem>
  81. <para><glossterm linkend='var-DISTRO'><link linkend='var-DISTRO'>DISTRO</link></glossterm></para>
  82. </listitem>
  83. <listitem>
  84. <para><glossterm linkend='var-MACHINE'><link linkend='var-MACHINE'>MACHINE</link></glossterm></para>
  85. </listitem>
  86. <listitem>
  87. <para><glossterm linkend='var-DL_DIR'><link linkend='var-DL_DIR'>DL_DIR</link></glossterm></para>
  88. </listitem>
  89. <listitem>
  90. <para><glossterm linkend='var-BBFILES'><link linkend='var-BBFILES'>BBFILES</link></glossterm></para>
  91. </listitem>
  92. <listitem>
  93. <para><glossterm linkend='var-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm></para>
  94. </listitem>
  95. <listitem>
  96. <para><glossterm linkend='var-PACKAGE_CLASSES'><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm></para>
  97. </listitem>
  98. <listitem>
  99. <para><glossterm linkend='var-BB_NUMBER_THREADS'><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></glossterm></para>
  100. </listitem>
  101. <listitem>
  102. <para><glossterm linkend='var-BBINCLUDELOGS'><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link></glossterm></para>
  103. </listitem>
  104. <listitem>
  105. <para><glossterm linkend='var-CVS_TARBALL_STASH'><link linkend='var-CVS_TARBALL_STASH'>CVS_TARBALL_STASH</link></glossterm></para>
  106. </listitem>
  107. <listitem>
  108. <para><glossterm linkend='var-ENABLE_BINARY_LOCALE_GENERATION'><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link></glossterm></para>
  109. </listitem>
  110. </itemizedlist>
  111. </section>
  112. <section id='ref-varlocality-recipe-required'>
  113. <title>Recipe Variables - Required</title>
  114. <itemizedlist>
  115. <listitem>
  116. <para><glossterm><link linkend='var-DESCRIPTION'>DESCRIPTION</link></glossterm></para>
  117. </listitem>
  118. <listitem>
  119. <para><glossterm><link linkend='var-LICENSE'>LICENSE</link></glossterm></para>
  120. </listitem>
  121. <listitem>
  122. <para><glossterm><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></glossterm></para>
  123. </listitem>
  124. <listitem>
  125. <para><glossterm><link linkend='var-SECTION'>SECTION</link></glossterm></para>
  126. </listitem>
  127. <listitem>
  128. <para><glossterm><link linkend='var-HOMEPAGE'>HOMEPAGE</link></glossterm></para>
  129. </listitem>
  130. <listitem>
  131. <para><glossterm><link linkend='var-AUTHOR'>AUTHOR</link></glossterm></para>
  132. </listitem>
  133. <listitem>
  134. <para><glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm></para>
  135. </listitem>
  136. </itemizedlist>
  137. </section>
  138. <section id='ref-varlocality-recipe-dependencies'>
  139. <title>Recipe Variables - Dependencies</title>
  140. <itemizedlist>
  141. <listitem>
  142. <para><glossterm><link linkend='var-DEPENDS'>DEPENDS</link></glossterm></para>
  143. </listitem>
  144. <listitem>
  145. <para><glossterm><link linkend='var-RDEPENDS'>RDEPENDS</link></glossterm></para>
  146. </listitem>
  147. <listitem>
  148. <para><glossterm><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></glossterm></para>
  149. </listitem>
  150. <listitem>
  151. <para><glossterm><link linkend='var-RCONFLICTS'>RCONFLICTS</link></glossterm></para>
  152. </listitem>
  153. <listitem>
  154. <para><glossterm><link linkend='var-RREPLACES'>RREPLACES</link></glossterm></para>
  155. </listitem>
  156. </itemizedlist>
  157. </section>
  158. <section id='ref-varlocality-recipe-paths'>
  159. <title>Recipe Variables - Paths</title>
  160. <itemizedlist>
  161. <listitem>
  162. <para><glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm></para>
  163. </listitem>
  164. <listitem>
  165. <para><glossterm><link linkend='var-S'>S</link></glossterm></para>
  166. </listitem>
  167. <listitem>
  168. <para><glossterm><link linkend='var-FILES'>FILES</link></glossterm></para>
  169. </listitem>
  170. </itemizedlist>
  171. </section>
  172. <section id='ref-varlocality-recipe-build'>
  173. <title>Recipe Variables - Extra Build Information</title>
  174. <itemizedlist>
  175. <listitem>
  176. <para><glossterm><link
  177. linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link></glossterm></para>
  178. </listitem>
  179. <listitem>
  180. <para><glossterm><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></glossterm></para>
  181. </listitem>
  182. <listitem>
  183. <para><glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm></para>
  184. </listitem>
  185. <listitem>
  186. <para><glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm></para>
  187. </listitem>
  188. <listitem>
  189. <para><glossterm><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></glossterm></para>
  190. </listitem>
  191. </itemizedlist>
  192. </section>
  193. </appendix>
  194. <!--
  195. vim: expandtab tw=80 ts=4 spell spelllang=en_gb
  196. -->