ref-variables.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  1. <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  3. <!-- Dummy chapter -->
  4. <appendix id='ref-variables-glos'>
  5. <title>Reference: Variables Glossary</title>
  6. <para>
  7. This section lists common variables used in Poky and gives an overview
  8. of their function and contents.
  9. </para>
  10. <glossary id='ref-variables-glossary'>
  11. <para>
  12. <link linkend='var-glossary-a'>A</link>
  13. <link linkend='var-glossary-b'>B</link>
  14. <link linkend='var-glossary-c'>C</link>
  15. <link linkend='var-glossary-d'>D</link>
  16. <link linkend='var-glossary-e'>E</link>
  17. <link linkend='var-glossary-f'>F</link>
  18. <!-- <link linkend='var-glossary-g'>G</link> -->
  19. <link linkend='var-glossary-h'>H</link>
  20. <link linkend='var-glossary-i'>I</link>
  21. <!-- <link linkend='var-glossary-j'>J</link> -->
  22. <link linkend='var-glossary-k'>K</link>
  23. <link linkend='var-glossary-l'>L</link>
  24. <link linkend='var-glossary-m'>M</link>
  25. <!-- <link linkend='var-glossary-n'>N</link> -->
  26. <!-- <link linkend='var-glossary-o'>O</link> -->
  27. <link linkend='var-glossary-p'>P</link>
  28. <!-- <link linkend='var-glossary-q'>Q</link> -->
  29. <link linkend='var-glossary-r'>R</link>
  30. <link linkend='var-glossary-s'>S</link>
  31. <link linkend='var-glossary-t'>T</link>
  32. <!-- <link linkend='var-glossary-u'>U</link> -->
  33. <!-- <link linkend='var-glossary-v'>V</link> -->
  34. <link linkend='var-glossary-w'>W</link>
  35. <!-- <link linkend='var-glossary-x'>X</link> -->
  36. <!-- <link linkend='var-glossary-y'>Y</link> -->
  37. <!-- <link linkend='var-glossary-z'>Z</link>-->
  38. </para>
  39. <glossdiv id='var-glossary-a'><title>A</title>
  40. <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
  41. <glossdef>
  42. <para>E-mail address to contact original author(s) - to
  43. send patches, forward bugs...</para>
  44. </glossdef>
  45. </glossentry>
  46. <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
  47. <glossdef>
  48. <para>Use current (newest) source revision - used with
  49. <glossterm><link linkend='var-SRCREV'>SRCREV</link></glossterm>
  50. variable.</para>
  51. </glossdef>
  52. </glossentry>
  53. </glossdiv>
  54. <glossdiv id='var-glossary-b'><title>B</title>
  55. <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
  56. <glossdef>
  57. <para>The maximum number of tasks BitBake should run in parallel at any one time</para>
  58. </glossdef>
  59. </glossentry>
  60. <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
  61. <glossdef>
  62. <para>List of recipes used by BitBake to build software</para>
  63. </glossdef>
  64. </glossentry>
  65. <!-- BBPATH is not a usable variable in .bb files and should not be listed here -->
  66. <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
  67. <glossdef>
  68. <para>Variable which controls how BitBake displays logs on build failure.</para>
  69. </glossdef>
  70. </glossentry>
  71. <glossentry id='var-BPN'><glossterm>BPN</glossterm>
  72. <glossdef>
  73. <para>Bare name of package with any suffixes like -cross -native
  74. removed. </para>
  75. </glossdef>
  76. </glossentry>
  77. </glossdiv>
  78. <glossdiv id='var-glossary-c'><title>C</title>
  79. <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm>
  80. <glossdef>
  81. <para>
  82. Flags passed to C compiler for the target system. Evaluates to the same
  83. as <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>.
  84. </para>
  85. </glossdef>
  86. </glossentry>
  87. <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
  88. <glossdef>
  89. <para>A regular expression which evalutates to match the machines the recipe
  90. works with. It stops recipes being run on machines they're incompatible with,
  91. which is partciuarly useful with kernels. It also helps to increase parsing
  92. speed as further parsing of the recipe is skipped as if it found the current
  93. machine is not compatible.</para>
  94. </glossdef>
  95. </glossentry>
  96. <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
  97. <glossdef>
  98. <para>
  99. A list of files which contains autoconf test results relevant
  100. to the current build. This variable is used by the autotools utilities
  101. when running configure.
  102. </para>
  103. </glossdef>
  104. </glossentry>
  105. </glossdiv>
  106. <glossdiv id='var-glossary-d'><title>D</title>
  107. <glossentry id='var-D'><glossterm>D</glossterm>
  108. <glossdef>
  109. <para>Destination directory</para>
  110. </glossdef>
  111. </glossentry>
  112. <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
  113. <glossdef>
  114. <para>
  115. Build packages with debugging information. This influences the value
  116. <link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link>
  117. takes.
  118. </para>
  119. </glossdef>
  120. </glossentry>
  121. <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
  122. <glossdef>
  123. <para>
  124. The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
  125. and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling a system for debugging.
  126. This defaults to "-O -fno-omit-frame-pointer -g".
  127. </para>
  128. </glossdef>
  129. </glossentry>
  130. <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
  131. <glossdef>
  132. <para>Priority of recipe</para>
  133. </glossdef>
  134. </glossentry>
  135. <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
  136. <glossdef>
  137. <para>
  138. A list of build time dependencies for a given recipe. These indicate
  139. recipes that must have staged before this recipe can configure.
  140. </para>
  141. </glossdef>
  142. </glossentry>
  143. <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
  144. <glossdef>
  145. <para>Package description used by package
  146. managers</para>
  147. </glossdef>
  148. </glossentry>
  149. <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm>
  150. <glossdef>
  151. <para>Destination directory</para>
  152. </glossdef>
  153. </glossentry>
  154. <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
  155. <glossdef>
  156. <para>Short name of distribution</para>
  157. </glossdef>
  158. </glossentry>
  159. <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
  160. <glossdef>
  161. <para>List of packages required by distribution.</para>
  162. </glossdef>
  163. </glossentry>
  164. <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
  165. <glossdef>
  166. <para>List of packages which extend usability of
  167. image. Those packages will be automatically
  168. installed but can be removed by user.</para>
  169. </glossdef>
  170. </glossentry>
  171. <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
  172. <glossdef>
  173. <para>Features of the distribution.</para>
  174. </glossdef>
  175. </glossentry>
  176. <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
  177. <glossdef>
  178. <para>Long name of distribution</para>
  179. </glossdef>
  180. </glossentry>
  181. <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
  182. <glossdef>
  183. <para>Alias names of the recipe in various Linux distributions. </para>
  184. <para>More information in
  185. <link
  186. linkend='usingpoky-configuring-DISTRO_PN_ALIAS'>
  187. Configuring the DISTRO_PN_ALIAS variable section
  188. </link>
  189. </para>
  190. </glossdef>
  191. </glossentry>
  192. <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
  193. <glossdef>
  194. <para>Version of distribution</para>
  195. </glossdef>
  196. </glossentry>
  197. <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
  198. <glossdef>
  199. <para>Directory where all fetched sources will be stored</para>
  200. </glossdef>
  201. </glossentry>
  202. </glossdiv>
  203. <glossdiv id='var-glossary-e'><title>E</title>
  204. <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
  205. <glossdef>
  206. <para>Variable which control which locales for glibc are
  207. to be generated during build (useful if target device
  208. has 64M RAM or less)</para>
  209. </glossdef>
  210. </glossentry>
  211. <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
  212. <glossdef>
  213. <para>Additional cmake options</para>
  214. </glossdef>
  215. </glossentry>
  216. <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
  217. <glossdef>
  218. <para>Additional 'configure' script options</para>
  219. </glossdef>
  220. </glossentry>
  221. <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
  222. <glossdef>
  223. <para>Additional GNU make options</para>
  224. </glossdef>
  225. </glossentry>
  226. </glossdiv>
  227. <glossdiv id='var-glossary-f'><title>F</title>
  228. <glossentry id='var-FILES'><glossterm>FILES</glossterm>
  229. <glossdef>
  230. <para>list of directories/files which will be placed
  231. in packages</para>
  232. </glossdef>
  233. </glossentry>
  234. <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
  235. <glossdef>
  236. <para>
  237. The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>
  238. and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling an optimised system.
  239. This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
  240. </para>
  241. </glossdef>
  242. </glossentry>
  243. </glossdiv>
  244. <!-- <glossdiv id='var-glossary-g'><title>G</title>-->
  245. <!-- </glossdiv>-->
  246. <glossdiv id='var-glossary-h'><title>H</title>
  247. <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm>
  248. <glossdef>
  249. <para>Website where more info about package can be found</para>
  250. </glossdef>
  251. </glossentry>
  252. </glossdiv>
  253. <glossdiv id='var-glossary-i'><title>I</title>
  254. <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
  255. <glossdef>
  256. <para><link linkend="ref-features-image">List of
  257. features</link> present in resulting images</para>
  258. </glossdef>
  259. </glossentry>
  260. <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
  261. <glossdef>
  262. <para>Formats of rootfs images which we want to have
  263. created</para>
  264. </glossdef>
  265. </glossentry>
  266. <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
  267. <glossdef>
  268. <para>List of packages used to build image</para>
  269. </glossdef>
  270. </glossentry>
  271. <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
  272. <glossdef>
  273. <para>
  274. This variable causes the build to not strip binaries in
  275. resulting packages.
  276. </para>
  277. </glossdef>
  278. </glossentry>
  279. <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
  280. <glossdef>
  281. <para>
  282. This variable causes the named class to be inherited at
  283. this point during parsing. Its only valid in configuration
  284. files.
  285. </para>
  286. </glossdef>
  287. </glossentry>
  288. <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
  289. <glossdef>
  290. <para>
  291. Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN.
  292. </para>
  293. <para>
  294. A list of the packages which contain initscripts. If multiple
  295. packages are specified you need to append the package name
  296. to the other INITSCRIPT_* as an override.
  297. </para>
  298. </glossdef>
  299. </glossentry>
  300. <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
  301. <glossdef>
  302. <para>
  303. Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
  304. </para>
  305. <para>
  306. The filename of the initscript (as installed to ${etcdir}/init.d).
  307. </para>
  308. </glossdef>
  309. </glossentry>
  310. <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
  311. <glossdef>
  312. <para>
  313. Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
  314. </para>
  315. <para>
  316. Specifies the options to pass to update-rc.d. An example is
  317. "start 99 5 2 . stop 20 0 1 6 ." which gives the script a
  318. runlevel of 99, starts the script in initlevels 2 and 5 and
  319. stops it in levels 0, 1 and 6.
  320. </para>
  321. </glossdef>
  322. </glossentry>
  323. </glossdiv>
  324. <!-- <glossdiv id='var-glossary-j'><title>J</title>-->
  325. <!-- </glossdiv>-->
  326. <glossdiv id='var-glossary-k'><title>K</title>
  327. <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
  328. <glossdef>
  329. <para>The type of kernel to build for a device, usually set by the
  330. machine configuration files and defaults to "zImage". This is used
  331. when building the kernel and is passed to "make" as the target to
  332. build.</para>
  333. </glossdef>
  334. </glossentry>
  335. </glossdiv>
  336. <glossdiv id='var-glossary-l'><title>L</title>
  337. <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
  338. <glossdef>
  339. <para>When used inside a layer.conf gives the path of the
  340. current layer. This variable requires immediate expansion
  341. (see the Bitbake manual) as lazy expansion can result in
  342. the expansion happening in the wrong directory and therefore
  343. giving the wrong value.</para>
  344. </glossdef>
  345. </glossentry>
  346. <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
  347. <glossdef>
  348. <para>List of package source licenses.</para>
  349. </glossdef>
  350. </glossentry>
  351. <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
  352. <glossdef>
  353. <para>Checksums of the license text in the recipe source code.
  354. </para>
  355. <para>This variable tracks changes in license text of the source
  356. code files. If the license text is changed, it will trigger the build
  357. failure, which gives developer an opportunity to review any
  358. license change</para>
  359. <para> This is an optional variable now, and the plan is to make
  360. it a required variable in the future </para>
  361. <para>See "meta/package/zlib/zlib_${PV}.bb" file for an example</para>
  362. <para>More information in <link
  363. linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
  364. Configuring the LIC_FILES_CHKSUM variable section</link></para>
  365. </glossdef>
  366. </glossentry>
  367. </glossdiv>
  368. <glossdiv id='var-glossary-m'><title>M</title>
  369. <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
  370. <glossdef>
  371. <para>Target device</para>
  372. </glossdef>
  373. </glossentry>
  374. <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm>
  375. <glossdef>
  376. <para>List of packages required to boot device</para>
  377. </glossdef>
  378. </glossentry>
  379. <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOMMENDS</glossterm>
  380. <glossdef>
  381. <para>List of packages required to boot device (usually
  382. additional kernel modules)</para>
  383. </glossdef>
  384. </glossentry>
  385. <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
  386. <glossdef>
  387. <para>List of packages required to use device</para>
  388. </glossdef>
  389. </glossentry>
  390. <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm>
  391. <glossdef>
  392. <para>List of packages useful to use device (for example
  393. additional kernel modules)</para>
  394. </glossdef>
  395. </glossentry>
  396. <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
  397. <glossdef>
  398. <para>List of device features - defined in <link
  399. linkend='ref-features-machine'>machine
  400. features section</link></para>
  401. </glossdef>
  402. </glossentry>
  403. <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm>
  404. <glossdef>
  405. <para>E-mail of distribution maintainer</para>
  406. </glossdef>
  407. </glossentry>
  408. </glossdiv>
  409. <!-- <glossdiv id='var-glossary-n'><title>N</title>-->
  410. <!-- </glossdiv>-->
  411. <!-- <glossdiv id='var-glossary-o'><title>O</title>-->
  412. <!-- </glossdiv>-->
  413. <glossdiv id='var-glossary-p'><title>P</title>
  414. <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
  415. <glossdef>
  416. <para>Architecture of resulting package</para>
  417. </glossdef>
  418. </glossentry>
  419. <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
  420. <glossdef>
  421. <para>List of resulting packages formats</para>
  422. </glossdef>
  423. </glossentry>
  424. <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm>
  425. <glossdef>
  426. <para>List of architectures compatible with device
  427. CPU. Usable when build is done for few different
  428. devices with misc processors (like XScale and
  429. ARM926-EJS)</para>
  430. </glossdef>
  431. </glossentry>
  432. <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
  433. <glossdef>
  434. <para>List of packages to be created from recipe.
  435. The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev"</para>
  436. </glossdef>
  437. </glossentry>
  438. <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm>
  439. <glossdef>
  440. <para>Extra options that are passed to the make command during the
  441. compile tasks. This is usually of the form '-j 4' where the number
  442. represents the maximum number of parallel threads make can run.</para>
  443. </glossdef>
  444. </glossentry>
  445. <glossentry id='var-PN'><glossterm>PN</glossterm>
  446. <glossdef>
  447. <para>Name of package.
  448. </para>
  449. </glossdef>
  450. </glossentry>
  451. <glossentry id='var-PR'><glossterm>PR</glossterm>
  452. <glossdef>
  453. <para>Revision of package.
  454. </para>
  455. </glossdef>
  456. </glossentry>
  457. <glossentry id='var-PV'><glossterm>PV</glossterm>
  458. <glossdef>
  459. <para>Version of package.
  460. The default value is "1.0"</para>
  461. </glossdef>
  462. </glossentry>
  463. <glossentry id='var-PE'><glossterm>PE</glossterm>
  464. <glossdef>
  465. <para>
  466. Epoch of the package. The default value is "0". The field is used
  467. to make upgrades possible when the versioning scheme changes in
  468. some backwards incompatible way.
  469. </para>
  470. </glossdef>
  471. </glossentry>
  472. <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm>
  473. <glossdef>
  474. <para>If multiple recipes provide an item, this variable
  475. determines which one should be given preference. It
  476. should be set to the "$PN" of the recipe to be preferred.</para>
  477. </glossdef>
  478. </glossentry>
  479. <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm>
  480. <glossdef>
  481. <para>
  482. If there are multiple versions of recipe available, this
  483. variable determines which one should be given preference. It
  484. should be set to the "$PV" of the recipe to be preferred.
  485. </para>
  486. </glossdef>
  487. </glossentry>
  488. <glossentry id='var-POKY_EXTRA_INSTALL'><glossterm>POKY_EXTRA_INSTALL</glossterm>
  489. <glossdef>
  490. <para>List of packages to be added to the image. This should
  491. only be set in <filename>local.conf</filename>.</para>
  492. </glossdef>
  493. </glossentry>
  494. <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm>
  495. <glossdef>
  496. <para>Libc implementation selector - glibc, eglibc, or uclibc can be selected.</para>
  497. </glossdef>
  498. </glossentry>
  499. <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm>
  500. <glossdef>
  501. <para>Toolchain selector. It can be external toolchain
  502. built from Poky or few supported combinations of
  503. upstream GCC or CodeSourcery Labs toolchain.</para>
  504. </glossdef>
  505. </glossentry>
  506. </glossdiv>
  507. <!-- <glossdiv id='var-glossary-q'><title>Q</title>-->
  508. <!-- </glossdiv>-->
  509. <glossdiv id='var-glossary-r'><title>R</title>
  510. <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
  511. <glossdef>
  512. <para>List of packages which conflict with this
  513. one. Package will not be installed if they are not
  514. removed first.</para>
  515. </glossdef>
  516. </glossentry>
  517. <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
  518. <glossdef>
  519. <para>
  520. A list of run-time dependencies for a package. These packages
  521. need to be installed alongside the package it applies to so
  522. the package will run correctly, an example is a perl script
  523. which would rdepend on perl. Since this variable applies to
  524. output packages there would usually be an override attached
  525. to this variable like RDEPENDS_${PN}-dev. Names in this field
  526. should be as they are in <link linkend='var-PACKAGES'>PACKAGES
  527. </link> namespace before any renaming of the output package
  528. by classes like debian.bbclass.
  529. </para>
  530. </glossdef>
  531. </glossentry>
  532. <glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm>
  533. <glossdef>
  534. <para>Size of rootfs in megabytes</para>
  535. </glossdef>
  536. </glossentry>
  537. <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
  538. <glossdef>
  539. <para>List of packages which extend usability of the
  540. package. Those packages will be automatically
  541. installed but can be removed by user.</para>
  542. </glossdef>
  543. </glossentry>
  544. <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
  545. <glossdef>
  546. <para>List of packages which are replaced with this
  547. one.</para>
  548. </glossdef>
  549. </glossentry>
  550. </glossdiv>
  551. <glossdiv id='var-glossary-s'><title>S</title>
  552. <glossentry id='var-S'><glossterm>S</glossterm>
  553. <glossdef>
  554. <para>
  555. Path to unpacked sources (by default:
  556. "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}")
  557. </para>
  558. </glossdef>
  559. </glossentry>
  560. <glossentry id='var-SECTION'><glossterm>SECTION</glossterm>
  561. <glossdef>
  562. <para>Section where package should be put - used
  563. by package managers</para>
  564. </glossdef>
  565. </glossentry>
  566. <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm>
  567. <glossdef>
  568. <para>
  569. The variable takes the value of <link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link>
  570. unless <link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link> = "1" in which case
  571. <link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link> is used.
  572. </para>
  573. </glossdef>
  574. </glossentry>
  575. <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
  576. <glossdef>
  577. <para>Speed and device for serial port used to attach
  578. serial console. This is given to kernel as "console"
  579. param and after boot getty is started on that port
  580. so remote login is possible.</para>
  581. </glossdef>
  582. </glossentry>
  583. <glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm>
  584. <glossdef>
  585. <para>
  586. A list of commands to run within the a shell, used by <glossterm><link
  587. linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm>.
  588. </para>
  589. </glossdef>
  590. </glossentry>
  591. <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm>
  592. <glossdef>
  593. <para>
  594. Contains "le" for little-endian or "be" for big-endian depending
  595. on the endian byte order of the target system.
  596. </para>
  597. </glossdef>
  598. </glossentry>
  599. <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm>
  600. <glossdef>
  601. <para>
  602. Contains "32" or "64" depending on the number of bits for the
  603. CPU of the target system.
  604. </para>
  605. </glossdef>
  606. </glossentry>
  607. <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
  608. <glossdef>
  609. <para>List of source files (local or remote ones)</para>
  610. </glossdef>
  611. </glossentry>
  612. <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
  613. <glossdef>
  614. <para>
  615. By default there is code which automatically detects whether
  616. <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>
  617. contains files which are machine specific and if this is the case it
  618. automatically changes
  619. <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm>.
  620. Setting this variable to "0" disables that behaviour.
  621. </para>
  622. </glossdef>
  623. </glossentry>
  624. <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm>
  625. <glossdef>
  626. <para>
  627. Date of source code used to build package (if it was fetched
  628. from SCM).
  629. </para>
  630. </glossdef>
  631. </glossentry>
  632. <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
  633. <glossdef>
  634. <para>
  635. Revision of source code used to build package (Subversion,
  636. GIT, Bazaar only).
  637. </para>
  638. </glossdef>
  639. </glossentry>
  640. <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
  641. <glossdef>
  642. <para>
  643. Directory with kernel headers required to build out-of-tree
  644. modules.
  645. </para>
  646. </glossdef>
  647. </glossentry>
  648. <glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm>
  649. <glossdef>
  650. <para>
  651. Directory (usually TMPDIR/stamps) with timestamps of
  652. executed tasks.
  653. </para>
  654. </glossdef>
  655. </glossentry>
  656. <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
  657. <glossdef>
  658. <para>Short (72 char suggested) Summary of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para>
  659. </glossdef>
  660. </glossentry>
  661. </glossdiv>
  662. <glossdiv id='var-glossary-t'><title>T</title>
  663. <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm>
  664. <glossdef>
  665. <para>The architecture of the device we're building for.
  666. A number of values are possible but Poky primarily supports
  667. "arm" and "i586".</para>
  668. </glossdef>
  669. </glossentry>
  670. <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm>
  671. <glossdef>
  672. <para>
  673. Flags passed to C compiler for the target system. Evaluates to the same
  674. as <link linkend='var-CFLAGS'>CFLAGS</link>.
  675. </para>
  676. </glossdef>
  677. </glossentry>
  678. <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
  679. <glossdef>
  680. <para>Method of handling FPU code. For FPU-less targets
  681. (most of ARM cpus) it has to be set to "soft" otherwise
  682. kernel emulation will get used which will result in
  683. performance penalty.</para>
  684. </glossdef>
  685. </glossentry>
  686. <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm>
  687. <glossdef>
  688. <para>Type of target operating system. Can be "linux"
  689. for glibc based system, "linux-uclibc" for uClibc. For
  690. ARM/EABI targets there are also "linux-gnueabi" and
  691. "linux-uclibc-gnueabi" values possible.</para>
  692. </glossdef>
  693. </glossentry>
  694. <glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm>
  695. <glossdef>
  696. <para>
  697. This command is used by bitbake to lauch a terminal window with a
  698. shell. The shell is unspecified so the user's default shell is used.
  699. By default it is set to <command>gnome-terminal</command> but it can
  700. be any X11 terminal application or terminal multiplexers like screen.
  701. </para>
  702. </glossdef>
  703. </glossentry>
  704. <glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm>
  705. <glossdef>
  706. <para>
  707. This command is similar to <glossterm><link
  708. linkend='var-TERMCMD'>TERMCMD</link></glossterm> however instead of the users shell it runs the command specified by the <glossterm><link
  709. linkend='var-SHELLCMDS'>SHELLCMDS</link></glossterm> variable.
  710. </para>
  711. </glossdef>
  712. </glossentry>
  713. </glossdiv>
  714. <!-- <glossdiv id='var-glossary-u'><title>U</title>-->
  715. <!-- </glossdiv>-->
  716. <!-- <glossdiv id='var-glossary-v'><title>V</title>-->
  717. <!-- </glossdiv>-->
  718. <glossdiv id='var-glossary-w'><title>W</title>
  719. <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
  720. <glossdef>
  721. <para>Path to directory in tmp/work/ where package
  722. will be built.</para>
  723. </glossdef>
  724. </glossentry>
  725. </glossdiv>
  726. <!-- <glossdiv id='var-glossary-x'><title>X</title>-->
  727. <!-- </glossdiv>-->
  728. <!-- <glossdiv id='var-glossary-y'><title>Y</title>-->
  729. <!-- </glossdiv>-->
  730. <!-- <glossdiv id='var-glossary-z'><title>Z</title>-->
  731. <!-- </glossdiv>-->
  732. </glossary>
  733. </appendix>
  734. <!--
  735. vim: expandtab tw=80 ts=4
  736. -->