diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-08-22 16:22:43 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-08-23 18:47:06 -0700 |
| commit | 70bd76e65878e1c5fb72473523807d79ce5d1ddc (patch) | |
| tree | 61f6b3e0d072b1035e1494910393e583b186fd3c /documentation/poky-ref-manual | |
| parent | 7a59fbde96ddb6ac2760d08b459f8513ef242034 (diff) | |
| download | poky-70bd76e65878e1c5fb72473523807d79ce5d1ddc.tar.gz | |
documentation/poky-ref-manual/ref-variables.xml: Scrubbed for Poky
I also fixed formatting and some minor wordings.
(From yocto-docs rev: b1bbfe89cb250ef5267fb16635dc41338aab0c59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual')
| -rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 608 |
1 files changed, 337 insertions, 271 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 1c9b3798e7..cca03a1b03 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
| @@ -66,22 +66,26 @@ | |||
| 66 | 66 | ||
| 67 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> | 67 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> |
| 68 | <glossdef> | 68 | <glossdef> |
| 69 | <para>The maximum number of tasks BitBake should run in parallel at any one time</para> | 69 | <para>The maximum number of tasks BitBake should run in parallel at any one time. |
| 70 | If your host development system supports mulitiple cores a good rule of thumb | ||
| 71 | is to set this variable to twice the number of cores.</para> | ||
| 70 | </glossdef> | 72 | </glossdef> |
| 71 | </glossentry> | 73 | </glossentry> |
| 72 | 74 | ||
| 73 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> | 75 | <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> |
| 74 | <glossdef> | 76 | <glossdef> |
| 75 | <para>Identifies layer-specific bbfiles, which contain recipes used by BitBake to build software. | 77 | <para>Identifies layer-specific <filename>.bbfiles</filename>, which contain recipes |
| 78 | used by BitBake to build software. | ||
| 76 | The Variable is appended with a layer name.</para> | 79 | The Variable is appended with a layer name.</para> |
| 77 | </glossdef> | 80 | </glossdef> |
| 78 | </glossentry> | 81 | </glossentry> |
| 79 | 82 | ||
| 80 | <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> | 83 | <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> |
| 81 | <glossdef> | 84 | <glossdef> |
| 82 | <para>Variable that expands to match files from BBFILES in a particular layer. BBFILE_PATTERN | 85 | <para>Variable that expands to match files from <filename>BBFILES</filename> in a particular layer. |
| 83 | is used in the <filename>conf/layer.conf</filename> file and must contain the name of the | 86 | This variable is used in the <filename>conf/layer.conf</filename> file and must |
| 84 | specific layer (e.g. BBFILE_PATTERN_emenlow).</para> | 87 | contain the name of the |
| 88 | specific layer (e.g. <filename>BBFILE_PATTERN_emenlow</filename>).</para> | ||
| 85 | </glossdef> | 89 | </glossdef> |
| 86 | </glossentry> | 90 | </glossentry> |
| 87 | 91 | ||
| @@ -90,19 +94,18 @@ | |||
| 90 | <para>Assigns different priorities to recipe files in different layers.</para> | 94 | <para>Assigns different priorities to recipe files in different layers.</para> |
| 91 | <para>This variable is useful in situations where the same package appears in | 95 | <para>This variable is useful in situations where the same package appears in |
| 92 | more than one layer. | 96 | more than one layer. |
| 93 | Setting BBFILE_PRIORITY allows you to prioritize a | 97 | Setting this variable allows you to prioritize a |
| 94 | layer against other layers that contain the same package - effectively | 98 | layer against other layers that contain the same package - effectively |
| 95 | letting you control the precedence for the multiple layers. | 99 | letting you control the precedence for the multiple layers. |
| 96 | The precedence established through this variable stands regardless of a | 100 | The precedence established through this variable stands regardless of a |
| 97 | layer's package version (PV variable). | 101 | layer's package version (<filename>PV</filename> variable). |
| 98 | For example, a layer that has a package with a higher PV value but for | 102 | For example, a layer that has a package with a higher <filename>PV</filename> value but for |
| 99 | which the BBFILE_PRIORITY is set to have a lower precedence still has a | 103 | which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a |
| 100 | lower precedence.</para> | 104 | lower precedence.</para> |
| 101 | <para>A larger value for the BBFILE_PRIORITY variable results in a higher | 105 | <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher |
| 102 | precedence. | 106 | precedence. |
| 103 | For example, the value 6 has a higher precedence than the | 107 | For example, the value 6 has a higher precedence than the value 5. |
| 104 | value 5. | 108 | By default, the <filename>BBFILE_PRIORITY</filename> variable is set to the value 5.</para> |
| 105 | By default, the BBFILE_PRIORITY variable is set to the value 5.</para> | ||
| 106 | </glossdef> | 109 | </glossdef> |
| 107 | </glossentry> | 110 | </glossentry> |
| 108 | 111 | ||
| @@ -114,27 +117,39 @@ | |||
| 114 | 117 | ||
| 115 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> | 118 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> |
| 116 | <glossdef> | 119 | <glossdef> |
| 117 | <para>Used by Bitbake to locate bbclass and configuration files. This variable is analogous to | 120 | <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files. |
| 118 | the PATH variable.</para> | 121 | This variable is analogous to the <filename>PATH</filename> variable.</para> |
| 119 | </glossdef> | 122 | </glossdef> |
| 120 | </glossentry> | 123 | </glossentry> |
| 121 | 124 | ||
| 122 | <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> | 125 | <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> |
| 123 | <glossdef> | 126 | <glossdef> |
| 124 | <para>Variable which controls how BitBake displays logs on build failure.</para> | 127 | <para>Variable that controls how BitBake displays logs on build failure.</para> |
| 125 | </glossdef> | 128 | </glossdef> |
| 126 | </glossentry> | 129 | </glossentry> |
| 127 | 130 | ||
| 128 | <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> | 131 | <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> |
| 129 | <glossdef> | 132 | <glossdef> |
| 130 | <para>Lists in the <filename>bblayers.conf</filename> file layers to enable in the Poky build.</para> | 133 | <para>Lists the layers to enable during the Yocto Project build. |
| 134 | This variable is defined in the <filename>bblayers.conf</filename> configuration | ||
| 135 | file in the Yocto Project build directory. | ||
| 136 | Here is an example: | ||
| 137 | <literallayout class='monospaced'> | ||
| 138 | BBLAYERS = " \ | ||
| 139 | /home/scottrif/poky/meta \ | ||
| 140 | /home/scottrif/poky/meta-yocto \ | ||
| 141 | /home/scottrif/poky/meta-mykernel \ | ||
| 142 | " | ||
| 143 | </literallayout> | ||
| 144 | This example enables three layers, one of which is a custom, user-defined layer | ||
| 145 | named <filename>meta-mykernel</filename>. | ||
| 146 | </para> | ||
| 131 | </glossdef> | 147 | </glossdef> |
| 132 | </glossentry> | 148 | </glossentry> |
| 133 | 149 | ||
| 134 | <glossentry id='var-BPN'><glossterm>BPN</glossterm> | 150 | <glossentry id='var-BPN'><glossterm>BPN</glossterm> |
| 135 | <glossdef> | 151 | <glossdef> |
| 136 | <para>Bare name of package with any suffixes like -cross -native | 152 | <para>Bare name of package with any suffixes like -cross -native removed.</para> |
| 137 | removed. </para> | ||
| 138 | </glossdef> | 153 | </glossdef> |
| 139 | </glossentry> | 154 | </glossentry> |
| 140 | 155 | ||
| @@ -145,8 +160,9 @@ | |||
| 145 | <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> | 160 | <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> |
| 146 | <glossdef> | 161 | <glossdef> |
| 147 | <para> | 162 | <para> |
| 148 | Flags passed to C compiler for the target system. Evaluates to the same | 163 | Flags passed to C compiler for the target system. |
| 149 | as <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link>. | 164 | This variable evaluates to the same as |
| 165 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>. | ||
| 150 | </para> | 166 | </para> |
| 151 | </glossdef> | 167 | </glossdef> |
| 152 | </glossentry> | 168 | </glossentry> |
| @@ -154,19 +170,21 @@ | |||
| 154 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> | 170 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> |
| 155 | <glossdef> | 171 | <glossdef> |
| 156 | <para>A regular expression which evaluates to match the machines the recipe | 172 | <para>A regular expression which evaluates to match the machines the recipe |
| 157 | works with. It stops recipes being run on machines they're incompatible with, | 173 | works with. |
| 158 | which is particularly useful with kernels. It also helps to increase parsing | 174 | It stops recipes being run on machines for which they are not compatible. |
| 159 | speed as further parsing of the recipe is skipped as if it found the current | 175 | This is particularly useful with kernels. |
| 160 | machine is not compatible.</para> | 176 | It also helps to increase parsing speed as further parsing of the recipe is skipped |
| 177 | if it is found the current machine is not compatible.</para> | ||
| 161 | </glossdef> | 178 | </glossdef> |
| 162 | </glossentry> | 179 | </glossentry> |
| 163 | 180 | ||
| 164 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> | 181 | <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> |
| 165 | <glossdef> | 182 | <glossdef> |
| 166 | <para> | 183 | <para> |
| 167 | A list of files which contains autoconf test results relevant | 184 | A list of files that contains <filename>autoconf</filename> test results relevant |
| 168 | to the current build. This variable is used by the autotools utilities | 185 | to the current build. |
| 169 | when running configure. | 186 | This variable is used by the Autotools utilities when running |
| 187 | <filename>configure</filename>. | ||
| 170 | </para> | 188 | </para> |
| 171 | </glossdef> | 189 | </glossdef> |
| 172 | </glossentry> | 190 | </glossentry> |
| @@ -177,16 +195,17 @@ | |||
| 177 | 195 | ||
| 178 | <glossentry id='var-D'><glossterm>D</glossterm> | 196 | <glossentry id='var-D'><glossterm>D</glossterm> |
| 179 | <glossdef> | 197 | <glossdef> |
| 180 | <para>Destination directory</para> | 198 | <para>The destination directory.</para> |
| 181 | </glossdef> | 199 | </glossdef> |
| 182 | </glossentry> | 200 | </glossentry> |
| 183 | 201 | ||
| 184 | <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> | 202 | <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> |
| 185 | <glossdef> | 203 | <glossdef> |
| 186 | <para> | 204 | <para> |
| 187 | Build packages with debugging information. This influences the value | 205 | Specifies to build packages with debugging information. |
| 188 | <link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link> | 206 | This influences the value of the |
| 189 | takes. | 207 | <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> |
| 208 | variable. | ||
| 190 | </para> | 209 | </para> |
| 191 | </glossdef> | 210 | </glossdef> |
| 192 | </glossentry> | 211 | </glossentry> |
| @@ -194,94 +213,91 @@ | |||
| 194 | <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> | 213 | <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> |
| 195 | <glossdef> | 214 | <glossdef> |
| 196 | <para> | 215 | <para> |
| 197 | The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link> | 216 | The options to pass in |
| 198 | and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling a system for debugging. | 217 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> |
| 199 | This defaults to "-O -fno-omit-frame-pointer -g". | 218 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling |
| 219 | a system for debugging. | ||
| 220 | This variable defaults to "-O -fno-omit-frame-pointer -g". | ||
| 200 | </para> | 221 | </para> |
| 201 | </glossdef> | 222 | </glossdef> |
| 202 | </glossentry> | 223 | </glossentry> |
| 203 | 224 | ||
| 204 | <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> | 225 | <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> |
| 205 | <glossdef> | 226 | <glossdef> |
| 206 | <para>Priority of recipe</para> | 227 | <para>Specifies the priority of recipes.</para> |
| 207 | </glossdef> | 228 | </glossdef> |
| 208 | </glossentry> | 229 | </glossentry> |
| 209 | 230 | ||
| 210 | <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> | 231 | <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> |
| 211 | <glossdef> | 232 | <glossdef> |
| 212 | <para> | 233 | <para> |
| 213 | A list of build time dependencies for a given recipe. These indicate | 234 | A list of build-time dependencies for a given recipe. |
| 214 | recipes that must have staged before this recipe can configure. | 235 | The variable indicates recipes that must have been staged before a |
| 236 | particular recipe can configure. | ||
| 215 | </para> | 237 | </para> |
| 216 | </glossdef> | 238 | </glossdef> |
| 217 | </glossentry> | 239 | </glossentry> |
| 218 | 240 | ||
| 219 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> | 241 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> |
| 220 | <glossdef> | 242 | <glossdef> |
| 221 | <para>Package description used by package | 243 | <para>The package description used by package managers.</para> |
| 222 | managers</para> | ||
| 223 | </glossdef> | 244 | </glossdef> |
| 224 | </glossentry> | 245 | </glossentry> |
| 225 | 246 | ||
| 226 | <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm> | 247 | <glossentry id='var-DESTDIR'><glossterm>DESTDIR</glossterm> |
| 227 | <glossdef> | 248 | <glossdef> |
| 228 | <para>Destination directory</para> | 249 | <para>the destination directory.</para> |
| 229 | </glossdef> | 250 | </glossdef> |
| 230 | </glossentry> | 251 | </glossentry> |
| 231 | 252 | ||
| 232 | <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> | 253 | <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> |
| 233 | <glossdef> | 254 | <glossdef> |
| 234 | <para>Short name of distribution</para> | 255 | <para>The short name of the distribution.</para> |
| 235 | </glossdef> | 256 | </glossdef> |
| 236 | </glossentry> | 257 | </glossentry> |
| 237 | 258 | ||
| 238 | <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> | 259 | <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> |
| 239 | <glossdef> | 260 | <glossdef> |
| 240 | <para>List of packages required by distribution.</para> | 261 | <para>The list of packages required by the distribution.</para> |
| 241 | </glossdef> | 262 | </glossdef> |
| 242 | </glossentry> | 263 | </glossentry> |
| 243 | 264 | ||
| 244 | <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> | 265 | <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> |
| 245 | <glossdef> | 266 | <glossdef> |
| 246 | <para>List of packages which extend usability of | 267 | <para>The list of packages which extend usability of the image. |
| 247 | image. Those packages will be automatically | 268 | Those packages will automatically be installed but can be removed by user.</para> |
| 248 | installed but can be removed by user.</para> | ||
| 249 | </glossdef> | 269 | </glossdef> |
| 250 | </glossentry> | 270 | </glossentry> |
| 251 | 271 | ||
| 252 | <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> | 272 | <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> |
| 253 | <glossdef> | 273 | <glossdef> |
| 254 | <para>Features of the distribution.</para> | 274 | <para>The features of the distribution.</para> |
| 255 | </glossdef> | 275 | </glossdef> |
| 256 | </glossentry> | 276 | </glossentry> |
| 257 | 277 | ||
| 258 | <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> | 278 | <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> |
| 259 | <glossdef> | 279 | <glossdef> |
| 260 | <para>Long name of distribution</para> | 280 | <para>The long name of the distribution.</para> |
| 261 | </glossdef> | 281 | </glossdef> |
| 262 | </glossentry> | 282 | </glossentry> |
| 263 | 283 | ||
| 264 | <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> | 284 | <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm> |
| 265 | <glossdef> | 285 | <glossdef> |
| 266 | <para>Alias names of the recipe in various Linux distributions. </para> | 286 | <para>Alias names used for the recipe in various Linux distributions.</para> |
| 267 | <para>More information in | 287 | <para>See <link linkend='usingpoky-configuring-DISTRO_PN_ALIAS'> |
| 268 | <link | 288 | Handling a Package Name Alias</link> section for more information.</para> |
| 269 | linkend='usingpoky-configuring-DISTRO_PN_ALIAS'> | ||
| 270 | Configuring the DISTRO_PN_ALIAS variable section | ||
| 271 | </link> | ||
| 272 | </para> | ||
| 273 | </glossdef> | 289 | </glossdef> |
| 274 | </glossentry> | 290 | </glossentry> |
| 275 | 291 | ||
| 276 | <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> | 292 | <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> |
| 277 | <glossdef> | 293 | <glossdef> |
| 278 | <para>Version of distribution</para> | 294 | <para>the version of the distribution.</para> |
| 279 | </glossdef> | 295 | </glossdef> |
| 280 | </glossentry> | 296 | </glossentry> |
| 281 | 297 | ||
| 282 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> | 298 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> |
| 283 | <glossdef> | 299 | <glossdef> |
| 284 | <para>Directory where all fetched sources will be stored</para> | 300 | <para>The directory where all fetched sources will be stored.</para> |
| 285 | </glossdef> | 301 | </glossdef> |
| 286 | 302 | ||
| 287 | </glossentry> | 303 | </glossentry> |
| @@ -291,9 +307,9 @@ | |||
| 291 | 307 | ||
| 292 | <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> | 308 | <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> |
| 293 | <glossdef> | 309 | <glossdef> |
| 294 | <para>Variable which control which locales for glibc are | 310 | <para>Variable that controls which locales for <filename>glibc</filename> are |
| 295 | to be generated during build (useful if target device | 311 | to be generated during the build (useful if the target device has 64Mbytes |
| 296 | has 64M RAM or less)</para> | 312 | of RAM or less).</para> |
| 297 | </glossdef> | 313 | </glossdef> |
| 298 | </glossentry> | 314 | </glossentry> |
| 299 | 315 | ||
| @@ -303,58 +319,58 @@ | |||
| 303 | You set this variable in the <filename>local.conf</filename> | 319 | You set this variable in the <filename>local.conf</filename> |
| 304 | configuration file. | 320 | configuration file. |
| 305 | Note that some image features are also added using the | 321 | Note that some image features are also added using the |
| 306 | <link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link> | 322 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> |
| 307 | variable generally configured in image recipes. | 323 | variable generally configured in image recipes. |
| 308 | You can use the EXTRA_IMAGE_FEATURES variable to add more features | 324 | You can use this variable to add more features in addition to those. |
| 309 | in addition to those. | ||
| 310 | Here are some exmaples of features you can add:</para> | 325 | Here are some exmaples of features you can add:</para> |
| 311 | <literallayout class='monospaced'> | 326 | <literallayout class='monospaced'> |
| 312 | "dbg-pkgs" - Adds -dbg packages for all installed packages | 327 | "dbg-pkgs" - Adds -dbg packages for all installed packages |
| 313 | including symbol information for debugging and | 328 | including symbol information for debugging and |
| 314 | profiling. | 329 | profiling. |
| 315 | 330 | ||
| 316 | "dev-pkgs" - Adds -dev packages for all installed packages. | 331 | "dev-pkgs" - Adds -dev packages for all installed packages. |
| 317 | This is useful if you want to develop against | 332 | This is useful if you want to develop against |
| 318 | the libraries in the image. | 333 | the libraries in the image. |
| 319 | 334 | ||
| 320 | "tools-sdk" - Adds development tools such as gcc, make, | 335 | "tools-sdk" - Adds development tools such as gcc, make, |
| 321 | pkgconfig and so forth. | 336 | pkgconfig and so forth. |
| 322 | 337 | ||
| 323 | "tools-debug" - Adds debugging tools such as gdb and | 338 | "tools-debug" - Adds debugging tools such as gdb and |
| 324 | strace. | 339 | strace. |
| 325 | 340 | ||
| 326 | "tools-profile" - Adds profiling tools such as oprofile, | 341 | "tools-profile" - Adds profiling tools such as oprofile, |
| 327 | exmap, lttng and valgrind (x86 only). | 342 | exmap, lttng and valgrind (x86 only). |
| 328 | 343 | ||
| 329 | "tools-testapps" - Adds useful testing tools such as ts_print, | 344 | "tools-testapps" - Adds useful testing tools such as |
| 330 | aplay, arecord and so forth. | 345 | ts_print, aplay, arecord and so |
| 331 | 346 | forth. | |
| 332 | "debug-tweaks" - Makes an image suitable for development. | 347 | |
| 333 | For example, ssh root access has a blank | 348 | "debug-tweaks" - Makes an image suitable for development. |
| 334 | password. There are other application | 349 | For example, ssh root access has a blank |
| 335 | targets too, see meta/classes/poky-image.bbclass | 350 | password. There are other application |
| 336 | and meta/packages/tasks/task-poky.bb | 351 | targets too, see |
| 337 | for more details. | 352 | meta/classes/poky-image.bbclass |
| 353 | and meta/packages/tasks/task-poky.bb | ||
| 354 | for more details. | ||
| 338 | </literallayout> | 355 | </literallayout> |
| 339 | |||
| 340 | </glossdef> | 356 | </glossdef> |
| 341 | </glossentry> | 357 | </glossentry> |
| 342 | 358 | ||
| 343 | <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm> | 359 | <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm> |
| 344 | <glossdef> | 360 | <glossdef> |
| 345 | <para>Additional cmake options</para> | 361 | <para>Additional <filename>cmake</filename> options.</para> |
| 346 | </glossdef> | 362 | </glossdef> |
| 347 | </glossentry> | 363 | </glossentry> |
| 348 | 364 | ||
| 349 | <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> | 365 | <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> |
| 350 | <glossdef> | 366 | <glossdef> |
| 351 | <para>Additional 'configure' script options</para> | 367 | <para>Additional <filename>configure</filename> script options.</para> |
| 352 | </glossdef> | 368 | </glossdef> |
| 353 | </glossentry> | 369 | </glossentry> |
| 354 | 370 | ||
| 355 | <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> | 371 | <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> |
| 356 | <glossdef> | 372 | <glossdef> |
| 357 | <para>Additional GNU make options</para> | 373 | <para>Additional GNU <filename>make</filename> options.</para> |
| 358 | </glossdef> | 374 | </glossdef> |
| 359 | </glossentry> | 375 | </glossentry> |
| 360 | 376 | ||
| @@ -364,17 +380,19 @@ | |||
| 364 | 380 | ||
| 365 | <glossentry id='var-FILES'><glossterm>FILES</glossterm> | 381 | <glossentry id='var-FILES'><glossterm>FILES</glossterm> |
| 366 | <glossdef> | 382 | <glossdef> |
| 367 | <para>list of directories/files which will be placed | 383 | <para>list of directories or files that are placed in packages.</para> |
| 368 | in packages</para> | ||
| 369 | </glossdef> | 384 | </glossdef> |
| 370 | </glossentry> | 385 | </glossentry> |
| 371 | 386 | ||
| 372 | <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> | 387 | <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> |
| 373 | <glossdef> | 388 | <glossdef> |
| 374 | <para> | 389 | <para> |
| 375 | The options to pass in <link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link> | 390 | The options to pass in |
| 376 | and <link linkend='var-CFLAGS'>CFLAGS</link> when compiling an optimised system. | 391 | <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> |
| 377 | This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2". | 392 | and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> |
| 393 | when compiling an optimised system. | ||
| 394 | This variable defaults to | ||
| 395 | <filename>-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2</filename>. | ||
| 378 | </para> | 396 | </para> |
| 379 | </glossdef> | 397 | </glossdef> |
| 380 | </glossentry> | 398 | </glossentry> |
| @@ -398,53 +416,52 @@ | |||
| 398 | 416 | ||
| 399 | <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> | 417 | <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> |
| 400 | <glossdef> | 418 | <glossdef> |
| 401 | <para><link linkend="ref-features-image">List of | 419 | <para>The list of features present in images. |
| 402 | features</link> present in resulting images. | 420 | Typically, you configure this variable in image recipes. |
| 403 | Typically you configure this variable in image recipes. | ||
| 404 | Note that you can add extra features to the image by using the | 421 | Note that you can add extra features to the image by using the |
| 405 | <link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link> | 422 | <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. |
| 406 | variable.</para> | 423 | See the <link linkend="ref-features-image">Reference: Images</link> section for the |
| 424 | list of features present in images built by the Yocto Project.</para> | ||
| 407 | </glossdef> | 425 | </glossdef> |
| 408 | </glossentry> | 426 | </glossentry> |
| 409 | 427 | ||
| 410 | <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> | 428 | <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> |
| 411 | <glossdef> | 429 | <glossdef> |
| 412 | <para>Formats of rootfs images which we want to have | 430 | <para>Formats of root filesystem images that you want to have created.</para> |
| 413 | created</para> | ||
| 414 | </glossdef> | 431 | </glossdef> |
| 415 | </glossentry> | 432 | </glossentry> |
| 416 | 433 | ||
| 417 | <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> | 434 | <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> |
| 418 | <glossdef> | 435 | <glossdef> |
| 419 | <para>List of packages used to build image</para> | 436 | <para>The list of packages used to build images.</para> |
| 420 | </glossdef> | 437 | </glossdef> |
| 421 | </glossentry> | 438 | </glossentry> |
| 422 | 439 | ||
| 423 | <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm> | 440 | <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm> |
| 424 | <glossdef> | 441 | <glossdef> |
| 425 | <para>Defines the Package revision. | 442 | <para>Defines the Package revision. |
| 426 | You manually combine values for INC_PR into the PR field of the parent recipe. | 443 | You manually combine values for <filename>INC_PR</filename> into the |
| 427 | When you change INC_PR you change the PR value for every person that includes the file. | 444 | <filename>PR</filename> field of the parent recipe. |
| 428 | </para> | 445 | When you change this variable, you change the <filename>PR</filename> |
| 446 | value for every person that includes the file.</para> | ||
| 429 | <para> | 447 | <para> |
| 430 | The following example shows how to use INC_PR given a common <filename>.inc</filename> | 448 | The following example shows how to use the <filename>INC_PR</filename> variable |
| 431 | that defines the variable. | 449 | given a common <filename>.inc</filename> file that defines the variable. |
| 432 | Once defined, the variable can be used to set the PR value: | 450 | Once defined, you can use the variable to set the <filename>PR</filename> value: |
| 433 | </para> | 451 | </para> |
| 434 | <programlisting> | 452 | <literallayout class='monospaced'> |
| 435 | recipes-graphics/xorg-font/font-util_1.1.1.bb:PR - "$(INC_PR).1" | 453 | recipes-graphics/xorg-font/font-util_1.1.1.bb:PR - "$(INC_PR).1" |
| 436 | recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR - "r1" | 454 | recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR - "r1" |
| 437 | recipes-graphics/xorg-font/encondings_1.0.3.bb:PR - "$(INC_PR).1" | 455 | recipes-graphics/xorg-font/encondings_1.0.3.bb:PR - "$(INC_PR).1" |
| 438 | recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | 456 | recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" |
| 439 | </programlisting> | 457 | </literallayout> |
| 440 | </glossdef> | 458 | </glossdef> |
| 441 | </glossentry> | 459 | </glossentry> |
| 442 | 460 | ||
| 443 | <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> | 461 | <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> |
| 444 | <glossdef> | 462 | <glossdef> |
| 445 | <para> | 463 | <para> |
| 446 | This variable causes the build to not strip binaries in | 464 | Causes the build to not strip binaries in resulting packages. |
| 447 | resulting packages. | ||
| 448 | </para> | 465 | </para> |
| 449 | </glossdef> | 466 | </glossdef> |
| 450 | </glossentry> | 467 | </glossentry> |
| @@ -453,9 +470,9 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 453 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> | 470 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> |
| 454 | <glossdef> | 471 | <glossdef> |
| 455 | <para> | 472 | <para> |
| 456 | This variable causes the named class to be inherited at | 473 | Causes the named class to be inherited at |
| 457 | this point during parsing. Its only valid in configuration | 474 | this point during parsing. |
| 458 | files. | 475 | The variable is only valid in configuration files. |
| 459 | </para> | 476 | </para> |
| 460 | </glossdef> | 477 | </glossdef> |
| 461 | </glossentry> | 478 | </glossentry> |
| @@ -464,23 +481,24 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 464 | <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> | 481 | <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> |
| 465 | <glossdef> | 482 | <glossdef> |
| 466 | <para> | 483 | <para> |
| 467 | Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN. | 484 | A list of the packages that contain initscripts. |
| 485 | If multiple packages are specified, you need to append the package name | ||
| 486 | to the other <filename>INITSCRIPT_*</filename> as an override.</para> | ||
| 487 | <para> | ||
| 488 | This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. | ||
| 489 | The variable is optional and defaults to <filename>PN</filename>. | ||
| 468 | </para> | 490 | </para> |
| 469 | <para> | 491 | </glossdef> |
| 470 | A list of the packages which contain initscripts. If multiple | ||
| 471 | packages are specified you need to append the package name | ||
| 472 | to the other INITSCRIPT_* as an override. | ||
| 473 | </para> | ||
| 474 | </glossdef> | ||
| 475 | </glossentry> | 492 | </glossentry> |
| 476 | 493 | ||
| 477 | <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> | 494 | <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> |
| 478 | <glossdef> | 495 | <glossdef> |
| 479 | <para> | 496 | <para> |
| 480 | Scope: Used in recipes when using update-rc.d.bbclass. Mandatory. | 497 | The filename of the initscript (as installed to <filename>${etcdir}/init.d)</filename>. |
| 481 | </para> | 498 | </para> |
| 482 | <para> | 499 | <para> |
| 483 | The filename of the initscript (as installed to ${etcdir}/init.d). | 500 | This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. |
| 501 | The variable is Mandatory. | ||
| 484 | </para> | 502 | </para> |
| 485 | </glossdef> | 503 | </glossdef> |
| 486 | </glossentry> | 504 | </glossentry> |
| @@ -488,13 +506,14 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 488 | <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> | 506 | <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> |
| 489 | <glossdef> | 507 | <glossdef> |
| 490 | <para> | 508 | <para> |
| 491 | Scope: Used in recipes when using update-rc.d.bbclass. Mandatory. | 509 | Specifies the options to pass to <filename>update-rc.d</filename>. |
| 510 | An example is <filename>start 99 5 2 . stop 20 0 1 6 .</filename>, which gives the script a | ||
| 511 | runlevel of 99, starts the script in initlevels 2 and 5, and | ||
| 512 | stops the script in levels 0, 1 and 6. | ||
| 492 | </para> | 513 | </para> |
| 493 | <para> | 514 | <para> |
| 494 | Specifies the options to pass to update-rc.d. An example is | 515 | The variable is mandatory and is used in recipes when using |
| 495 | "start 99 5 2 . stop 20 0 1 6 ." which gives the script a | 516 | <filename>update-rc.d.bbclass</filename>. |
| 496 | runlevel of 99, starts the script in initlevels 2 and 5 and | ||
| 497 | stops it in levels 0, 1 and 6. | ||
| 498 | </para> | 517 | </para> |
| 499 | </glossdef> | 518 | </glossdef> |
| 500 | </glossentry> | 519 | </glossentry> |
| @@ -510,9 +529,10 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 510 | <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> | 529 | <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> |
| 511 | <glossdef> | 530 | <glossdef> |
| 512 | <para>The type of kernel to build for a device, usually set by the | 531 | <para>The type of kernel to build for a device, usually set by the |
| 513 | machine configuration files and defaults to "zImage". This is used | 532 | machine configuration files and defaults to "zImage". |
| 514 | when building the kernel and is passed to "make" as the target to | 533 | This variable is used |
| 515 | build.</para> | 534 | when building the kernel and is passed to <filename>make</filename> as the target to |
| 535 | build.</para> | ||
| 516 | </glossdef> | 536 | </glossdef> |
| 517 | </glossentry> | 537 | </glossentry> |
| 518 | 538 | ||
| @@ -522,33 +542,35 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 522 | 542 | ||
| 523 | <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> | 543 | <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> |
| 524 | <glossdef> | 544 | <glossdef> |
| 525 | <para>When used inside a layer.conf gives the path of the | 545 | <para>When used inside the <filename>layer.conf</filename> configuration |
| 526 | current layer. This variable requires immediate expansion | 546 | file, this variable provides the path of the current layer. |
| 527 | (see the Bitbake manual) as lazy expansion can result in | 547 | This variable requires immediate expansion |
| 528 | the expansion happening in the wrong directory and therefore | 548 | (see the BitBake manual) as lazy expansion can result in |
| 529 | giving the wrong value.</para> | 549 | the expansion happening in the wrong directory and therefore |
| 550 | giving the wrong value.</para> | ||
| 530 | </glossdef> | 551 | </glossdef> |
| 531 | </glossentry> | 552 | </glossentry> |
| 553 | |||
| 532 | <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> | 554 | <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> |
| 533 | <glossdef> | 555 | <glossdef> |
| 534 | <para>List of package source licenses.</para> | 556 | <para>The list of package source licenses.</para> |
| 535 | </glossdef> | 557 | </glossdef> |
| 536 | </glossentry> | 558 | </glossentry> |
| 559 | |||
| 537 | <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> | 560 | <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> |
| 538 | <glossdef> | 561 | <glossdef> |
| 539 | <para>Checksums of the license text in the recipe source code. | 562 | <para>Checksums of the license text in the recipe source code.</para> |
| 540 | </para> | ||
| 541 | <para>This variable tracks changes in license text of the source | 563 | <para>This variable tracks changes in license text of the source |
| 542 | code files. If the license text is changed, it will trigger the build | 564 | code files. |
| 543 | failure, which gives developer an opportunity to review any | 565 | If the license text is changed, it will trigger the build |
| 544 | license change</para> | 566 | failure, which gives the developer an opportunity to review any |
| 545 | <para> This is an optional variable now, and the plan is to make | 567 | license change</para> |
| 546 | it a required variable in the future </para> | 568 | <para> |
| 547 | <para>See "meta/package/zlib/zlib_${PV}.bb" file for an example</para> | 569 | Currently, this variable is optional. |
| 548 | 570 | The plan is to make it a required variable in the future.</para> | |
| 549 | <para>More information in <link | 571 | <para>For more information, see the |
| 550 | linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> | 572 | <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> |
| 551 | Configuring the LIC_FILES_CHKSUM variable section</link></para> | 573 | Track License Change</link> section</para> |
| 552 | </glossdef> | 574 | </glossdef> |
| 553 | </glossentry> | 575 | </glossentry> |
| 554 | 576 | ||
| @@ -558,47 +580,47 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 558 | 580 | ||
| 559 | <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> | 581 | <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> |
| 560 | <glossdef> | 582 | <glossdef> |
| 561 | <para>Target device</para> | 583 | <para>Specifies the target device.</para> |
| 562 | </glossdef> | 584 | </glossdef> |
| 563 | </glossentry> | 585 | </glossentry> |
| 564 | 586 | ||
| 565 | <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm> | 587 | <glossentry id='var-MACHINE_ESSENTIAL_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_RDEPENDS</glossterm> |
| 566 | <glossdef> | 588 | <glossdef> |
| 567 | <para>List of packages required to boot device</para> | 589 | <para>Specifies the list of packages required to boot the device.</para> |
| 568 | </glossdef> | 590 | </glossdef> |
| 569 | </glossentry> | 591 | </glossentry> |
| 570 | 592 | ||
| 571 | <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOMMENDS</glossterm> | 593 | <glossentry id='var-MACHINE_ESSENTIAL_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_RRECOMMENDS</glossterm> |
| 572 | <glossdef> | 594 | <glossdef> |
| 573 | <para>List of packages required to boot device (usually | 595 | <para>Specifies the list of packages required to boot the device (usually |
| 574 | additional kernel modules)</para> | 596 | additional kernel modules).</para> |
| 575 | </glossdef> | 597 | </glossdef> |
| 576 | </glossentry> | 598 | </glossentry> |
| 577 | 599 | ||
| 578 | <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> | 600 | <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> |
| 579 | <glossdef> | 601 | <glossdef> |
| 580 | <para>List of packages required to use device</para> | 602 | <para>Specifies the list of packages required to use the devices</para> |
| 581 | </glossdef> | 603 | </glossdef> |
| 582 | </glossentry> | 604 | </glossentry> |
| 583 | 605 | ||
| 584 | <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm> | 606 | <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMNEDS</glossterm> |
| 585 | <glossdef> | 607 | <glossdef> |
| 586 | <para>List of packages useful to use device (for example | 608 | <para>Specifies the list of packages useful to use the device (e.g. |
| 587 | additional kernel modules)</para> | 609 | additional kernel modules)</para> |
| 588 | </glossdef> | 610 | </glossdef> |
| 589 | </glossentry> | 611 | </glossentry> |
| 590 | 612 | ||
| 591 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> | 613 | <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> |
| 592 | <glossdef> | 614 | <glossdef> |
| 593 | <para>List of device features - defined in <link | 615 | <para>Specifies the list of device features. |
| 594 | linkend='ref-features-machine'>machine | 616 | See the <link linkend='ref-features-machine'>Machine</link> section for |
| 595 | features section</link></para> | 617 | more information.</para> |
| 596 | </glossdef> | 618 | </glossdef> |
| 597 | </glossentry> | 619 | </glossentry> |
| 598 | 620 | ||
| 599 | <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> | 621 | <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> |
| 600 | <glossdef> | 622 | <glossdef> |
| 601 | <para>E-mail of distribution maintainer</para> | 623 | <para>The email address of the distribution maintainer.</para> |
| 602 | </glossdef> | 624 | </glossdef> |
| 603 | </glossentry> | 625 | </glossentry> |
| 604 | </glossdiv> | 626 | </glossdiv> |
| @@ -613,74 +635,85 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 613 | 635 | ||
| 614 | <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> | 636 | <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> |
| 615 | <glossdef> | 637 | <glossdef> |
| 616 | <para>Architecture of resulting package</para> | 638 | <para>The architecture of the resulting package.</para> |
| 617 | </glossdef> | 639 | </glossdef> |
| 618 | </glossentry> | 640 | </glossentry> |
| 619 | 641 | ||
| 620 | <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> | 642 | <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> |
| 621 | <glossdef> | 643 | <glossdef> |
| 622 | <para>List of resulting packages formats</para> | 644 | <para>Specifies the list of resulting package formats.</para> |
| 623 | </glossdef> | 645 | </glossdef> |
| 624 | </glossentry> | 646 | </glossentry> |
| 625 | 647 | ||
| 626 | <glossentry id='var-PACKAGE_DESCRIPTION'><glossterm>PACKAGE_DESCRIPTION</glossterm> | 648 | <glossentry id='var-PACKAGE_DESCRIPTION'><glossterm>PACKAGE_DESCRIPTION</glossterm> |
| 627 | <glossdef> | 649 | <glossdef> |
| 628 | <para>Long form description of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para> | 650 | <para>The long form description of the binary package for packaging sytems such as |
| 651 | <filename>ipkg</filename>, <filename>rpm</filename> or <filename>debian</filename>. | ||
| 652 | This variable inherits <filename>DESCRIPTION</filename> by default.</para> | ||
| 629 | </glossdef> | 653 | </glossdef> |
| 630 | </glossentry> | 654 | </glossentry> |
| 631 | 655 | ||
| 632 | <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> | 656 | <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> |
| 633 | <glossdef> | 657 | <glossdef> |
| 634 | <para>List of architectures compatible with device | 658 | <para>Specifies the list of architectures compatible with the device CPU. |
| 635 | CPU. Usable when build is done for few different | 659 | This variable is useful when you build for several different devices that use |
| 636 | devices with misc processors (like XScale and | 660 | miscellaneous processors such as XScale and ARM926-EJS).</para> |
| 637 | ARM926-EJS)</para> | ||
| 638 | </glossdef> | 661 | </glossdef> |
| 639 | </glossentry> | 662 | </glossentry> |
| 640 | 663 | ||
| 641 | <glossentry id='var-PACKAGE_SUMMARY'><glossterm>PACKAGE_SUMMARY</glossterm> | 664 | <glossentry id='var-PACKAGE_SUMMARY'><glossterm>PACKAGE_SUMMARY</glossterm> |
| 642 | <glossdef> | 665 | <glossdef> |
| 643 | <para>Short (72 char suggested) Summary of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para> | 666 | <para>The short (72 character limit suggested) summary of the binary |
| 667 | package for packaging sytems such as <filename>ipkg</filename>, | ||
| 668 | <filename>rpm</filename> or <filename>debian</filename>. | ||
| 669 | By default, this variable inherits <filename>DESCRIPTION</filename>.</para> | ||
| 644 | </glossdef> | 670 | </glossdef> |
| 645 | </glossentry> | 671 | </glossentry> |
| 646 | 672 | ||
| 647 | 673 | ||
| 648 | <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> | 674 | <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> |
| 649 | <glossdef> | 675 | <glossdef> |
| 650 | <para>List of packages to be created from recipe. | 676 | <para>The list of packages to be created from the recipe. |
| 651 | The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev"</para> | 677 | The default value is <filename>${PN}-dbg ${PN} ${PN}-doc ${PN}-dev</filename>.</para> |
| 652 | </glossdef> | 678 | </glossdef> |
| 653 | </glossentry> | 679 | </glossentry> |
| 654 | 680 | ||
| 655 | <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> | 681 | <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> |
| 656 | <glossdef> | 682 | <glossdef> |
| 657 | <para>Extra options that are passed to the make command during the | 683 | <para>Specifies extra options that are passed to the <filename>make</filename> command during the |
| 658 | compile tasks. This is usually of the form '-j 4' where the number | 684 | compile tasks. |
| 659 | represents the maximum number of parallel threads make can run.</para> | 685 | This variable is usually in the form <filename>-j 4</filename>, where the number |
| 686 | represents the maximum number of parallel threads make can run. | ||
| 687 | If you development host supports multiple cores a good rule of thumb is to set | ||
| 688 | this variable to one and a half times the number of cores on the host.</para> | ||
| 660 | </glossdef> | 689 | </glossdef> |
| 661 | </glossentry> | 690 | </glossentry> |
| 662 | 691 | ||
| 663 | <glossentry id='var-PN'><glossterm>PN</glossterm> | 692 | <glossentry id='var-PN'><glossterm>PN</glossterm> |
| 664 | <glossdef> | 693 | <glossdef> |
| 665 | <para>Name of package. | 694 | <para>The name of the package. |
| 666 | </para> | 695 | </para> |
| 667 | </glossdef> | 696 | </glossdef> |
| 668 | </glossentry> | 697 | </glossentry> |
| 669 | 698 | ||
| 670 | <glossentry id='var-PR'><glossterm>PR</glossterm> | 699 | <glossentry id='var-PR'><glossterm>PR</glossterm> |
| 671 | <glossdef> | 700 | <glossdef> |
| 672 | <para>Revision of package. The default value is "r0". | 701 | <para>The revision of the package. |
| 702 | The default value for this variable is "r0". | ||
| 673 | </para> | 703 | </para> |
| 674 | </glossdef> | 704 | </glossdef> |
| 675 | </glossentry> | 705 | </glossentry> |
| 676 | 706 | ||
| 677 | <glossentry id='var-PV'><glossterm>PV</glossterm> | 707 | <glossentry id='var-PV'><glossterm>PV</glossterm> |
| 678 | <glossdef> | 708 | <glossdef> |
| 679 | <para>Version of package. | 709 | <para>The version of the package. |
| 680 | This is normally extracted from the recipe name, e.g. if the recipe is named | 710 | The version is normally extracted from the recipe name. |
| 681 | "expat_2.0.1.bb" then PV will be "2.0.1". PV is generally not overridden within | 711 | For example, if the recipe is named |
| 712 | <filename>expat_2.0.1.bb</filename>, then <filename>PV</filename> | ||
| 713 | will be <filename>2.0.1</filename>. | ||
| 714 | <filename>PV</filename> is generally not overridden within | ||
| 682 | a recipe unless it is building an unstable version from a source code repository | 715 | a recipe unless it is building an unstable version from a source code repository |
| 683 | (git, svn, etc.). | 716 | (e.g. Git or Subversion). |
| 684 | </para> | 717 | </para> |
| 685 | </glossdef> | 718 | </glossdef> |
| 686 | </glossentry> | 719 | </glossentry> |
| @@ -688,8 +721,9 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 688 | <glossentry id='var-PE'><glossterm>PE</glossterm> | 721 | <glossentry id='var-PE'><glossterm>PE</glossterm> |
| 689 | <glossdef> | 722 | <glossdef> |
| 690 | <para> | 723 | <para> |
| 691 | Epoch of the package. The default value is "0". The field is used | 724 | the epoch of the package. |
| 692 | to make upgrades possible when the versioning scheme changes in | 725 | The default value is "0". |
| 726 | The field is used to make upgrades possible when the versioning scheme changes in | ||
| 693 | some backwards incompatible way. | 727 | some backwards incompatible way. |
| 694 | </para> | 728 | </para> |
| 695 | </glossdef> | 729 | </glossdef> |
| @@ -698,39 +732,46 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 698 | <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> | 732 | <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> |
| 699 | <glossdef> | 733 | <glossdef> |
| 700 | <para>If multiple recipes provide an item, this variable | 734 | <para>If multiple recipes provide an item, this variable |
| 701 | determines which one should be given preference. It | 735 | determines which recipe should be given preference. |
| 702 | should be set to the "$PN" of the recipe to be preferred.</para> | 736 | The variable should be set to the <filename>$PN</filename> of the recipe |
| 737 | to which you want to give precedence.</para> | ||
| 703 | </glossdef> | 738 | </glossdef> |
| 704 | </glossentry> | 739 | </glossentry> |
| 705 | 740 | ||
| 706 | <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> | 741 | <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> |
| 707 | <glossdef> | 742 | <glossdef> |
| 708 | <para> | 743 | <para> |
| 709 | If there are multiple versions of recipe available, this | 744 | If there are multiple versions of recipes available, this |
| 710 | variable determines which one should be given preference. It | 745 | variable determines which recipe should be given preference. |
| 711 | should be set to the "$PV" of the recipe to be preferred. | 746 | The variable should be set to the <filename>$PV</filename> of the recipe |
| 747 | to whichy you want to give precedence. | ||
| 712 | </para> | 748 | </para> |
| 713 | </glossdef> | 749 | </glossdef> |
| 714 | </glossentry> | 750 | </glossentry> |
| 715 | 751 | ||
| 716 | <glossentry id='var-POKY_EXTRA_INSTALL'><glossterm>POKY_EXTRA_INSTALL</glossterm> | 752 | <glossentry id='var-POKY_EXTRA_INSTALL'><glossterm>POKY_EXTRA_INSTALL</glossterm> |
| 717 | <glossdef> | 753 | <glossdef> |
| 718 | <para>List of packages to be added to the image. This should | 754 | <para>Specifies the list of packages to be added to the image. |
| 719 | only be set in <filename>local.conf</filename>.</para> | 755 | This variable should only be set in the <filename>local.conf</filename> |
| 756 | configuration file found in the Yocto Project's build directory.</para> | ||
| 720 | </glossdef> | 757 | </glossdef> |
| 721 | </glossentry> | 758 | </glossentry> |
| 722 | 759 | ||
| 723 | <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm> | 760 | <glossentry id='var-POKYLIBC'><glossterm>POKYLIBC</glossterm> |
| 724 | <glossdef> | 761 | <glossdef> |
| 725 | <para>Libc implementation selector - glibc, eglibc, or uclibc can be selected.</para> | 762 | <para>The <filename>libc</filename> implementation selector. |
| 763 | You can select <filename>glibc</filename>, <filename>eglibc</filename>, | ||
| 764 | or <filename>uclibc</filename>.</para> | ||
| 726 | </glossdef> | 765 | </glossdef> |
| 727 | </glossentry> | 766 | </glossentry> |
| 728 | 767 | ||
| 729 | <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm> | 768 | <glossentry id='var-POKYMODE'><glossterm>POKYMODE</glossterm> |
| 730 | <glossdef> | 769 | <glossdef> |
| 731 | <para>Toolchain selector. It can be external toolchain | 770 | <para>The toolchain selector. |
| 732 | built from Poky or few supported combinations of | 771 | This variable has been replaced by <filename>TCMODE</filename>. |
| 733 | upstream GCC or CodeSourcery Labs toolchain.</para> | 772 | The <filename>POKYMODE</filename> would select the external toolchain |
| 773 | built from the Yocto Project or a few supported combinations of | ||
| 774 | upstream GCC or CodeSourcery Labs toolchain.</para> | ||
| 734 | </glossdef> | 775 | </glossdef> |
| 735 | </glossentry> | 776 | </glossentry> |
| 736 | 777 | ||
| @@ -743,46 +784,46 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 743 | 784 | ||
| 744 | <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> | 785 | <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> |
| 745 | <glossdef> | 786 | <glossdef> |
| 746 | <para>List of packages which conflict with this | 787 | <para>The list of packages that conflict with this package. |
| 747 | one. Package will not be installed if they are not | 788 | Note that the package will not be installed if the conflicting packages are not |
| 748 | removed first.</para> | 789 | first removed.</para> |
| 749 | </glossdef> | 790 | </glossdef> |
| 750 | </glossentry> | 791 | </glossentry> |
| 751 | 792 | ||
| 752 | <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> | 793 | <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> |
| 753 | <glossdef> | 794 | <glossdef> |
| 754 | <para> | 795 | <para> |
| 755 | A list of run-time dependencies for a package. These packages | 796 | A list of run-time dependencies for a package. |
| 756 | need to be installed alongside the package it applies to so | 797 | These packages need to be installed alongside the package to which |
| 757 | the package will run correctly, an example is a perl script | 798 | they apply. |
| 758 | which would rdepend on perl. Since this variable applies to | 799 | This enables the package to run correctly. |
| 759 | output packages there would usually be an override attached | 800 | For example, consider a Perl script, which depends on the Perl package. |
| 760 | to this variable like RDEPENDS_${PN}-dev. Names in this field | 801 | Since this variable applies to |
| 761 | should be as they are in <link linkend='var-PACKAGES'>PACKAGES | 802 | output packages, there would usually be an override attached |
| 762 | </link> namespace before any renaming of the output package | 803 | to this variable such as <filename>RDEPENDS_${PN}-dev</filename>. |
| 763 | by classes like debian.bbclass. | 804 | Names in this field must appear as they appear in the |
| 805 | <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any | ||
| 806 | renaming of the output package by classes like <filename>debian.bbclass</filename>. | ||
| 764 | </para> | 807 | </para> |
| 765 | </glossdef> | 808 | </glossdef> |
| 766 | </glossentry> | 809 | </glossentry> |
| 767 | 810 | ||
| 768 | <glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm> | 811 | <glossentry id='var-ROOT_FLASH_SIZE'><glossterm>ROOT_FLASH_SIZE</glossterm> |
| 769 | <glossdef> | 812 | <glossdef> |
| 770 | <para>Size of rootfs in megabytes</para> | 813 | <para>The size of root filesystem as measured in megabytes.</para> |
| 771 | </glossdef> | 814 | </glossdef> |
| 772 | </glossentry> | 815 | </glossentry> |
| 773 | 816 | ||
| 774 | <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> | 817 | <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> |
| 775 | <glossdef> | 818 | <glossdef> |
| 776 | <para>List of packages which extend usability of the | 819 | <para>The list of packages that extend usability of the package. |
| 777 | package. Those packages will be automatically | 820 | The packages are automatically installed but can be removed by user.</para> |
| 778 | installed but can be removed by user.</para> | ||
| 779 | </glossdef> | 821 | </glossdef> |
| 780 | </glossentry> | 822 | </glossentry> |
| 781 | 823 | ||
| 782 | <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> | 824 | <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> |
| 783 | <glossdef> | 825 | <glossdef> |
| 784 | <para>List of packages which are replaced with this | 826 | <para>The list of packages that are replaced with this package.</para> |
| 785 | one.</para> | ||
| 786 | </glossdef> | 827 | </glossdef> |
| 787 | </glossentry> | 828 | </glossentry> |
| 788 | 829 | ||
| @@ -793,25 +834,28 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 793 | <glossentry id='var-S'><glossterm>S</glossterm> | 834 | <glossentry id='var-S'><glossterm>S</glossterm> |
| 794 | <glossdef> | 835 | <glossdef> |
| 795 | <para> | 836 | <para> |
| 796 | Path to unpacked sources (by default: | 837 | The path to unpacked sources. |
| 797 | "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}") | 838 | By default, this path is |
| 839 | "${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}". | ||
| 798 | </para> | 840 | </para> |
| 799 | </glossdef> | 841 | </glossdef> |
| 800 | </glossentry> | 842 | </glossentry> |
| 801 | 843 | ||
| 802 | <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> | 844 | <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> |
| 803 | <glossdef> | 845 | <glossdef> |
| 804 | <para>Section where package should be put - used | 846 | <para>The section where package should be put. |
| 805 | by package managers</para> | 847 | Package managers use this variable.</para> |
| 806 | </glossdef> | 848 | </glossdef> |
| 807 | </glossentry> | 849 | </glossentry> |
| 808 | 850 | ||
| 809 | <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> | 851 | <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> |
| 810 | <glossdef> | 852 | <glossdef> |
| 811 | <para> | 853 | <para> |
| 812 | The variable takes the value of <link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link> | 854 | The variable takes the value of |
| 813 | unless <link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link> = "1" in which case | 855 | <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename> |
| 814 | <link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link> is used. | 856 | unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1". |
| 857 | In this case the value of | ||
| 858 | <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used. | ||
| 815 | </para> | 859 | </para> |
| 816 | </glossdef> | 860 | </glossdef> |
| 817 | </glossentry> | 861 | </glossentry> |
| @@ -819,24 +863,24 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 819 | 863 | ||
| 820 | <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> | 864 | <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> |
| 821 | <glossdef> | 865 | <glossdef> |
| 822 | <para>Speed and device for serial port used to attach | 866 | <para>The speed and device for the serial port used to attach the serial console. |
| 823 | serial console. This is given to kernel as "console" | 867 | This variable is given to the kernel as the "console" |
| 824 | param and after boot getty is started on that port | 868 | parameter and after booting occurs <filename>getty</filename> is started on that port |
| 825 | so remote login is possible.</para> | 869 | so remote login is possible.</para> |
| 826 | </glossdef> | 870 | </glossdef> |
| 827 | </glossentry> | 871 | </glossentry> |
| 828 | 872 | ||
| 829 | <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm> | 873 | <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm> |
| 830 | <glossdef> | 874 | <glossdef> |
| 831 | <para>Directory for the shared state.</para> | 875 | <para>The directory for the shared state.</para> |
| 832 | </glossdef> | 876 | </glossdef> |
| 833 | 877 | ||
| 834 | </glossentry> | 878 | </glossentry> |
| 835 | <glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm> | 879 | <glossentry id='var-SHELLCMDS'><glossterm>SHELLCMDS</glossterm> |
| 836 | <glossdef> | 880 | <glossdef> |
| 837 | <para> | 881 | <para> |
| 838 | A list of commands to run within the a shell, used by <glossterm><link | 882 | A list of commands to run within the shell. |
| 839 | linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm>. | 883 | The list is used by <filename><link linkend='var-TERMCMDRUN'>TERMCMDRUN</link></filename>. |
| 840 | </para> | 884 | </para> |
| 841 | </glossdef> | 885 | </glossdef> |
| 842 | </glossentry> | 886 | </glossentry> |
| @@ -844,8 +888,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 844 | <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm> | 888 | <glossentry id='var-SITEINFO_ENDIANESS'><glossterm>SITEINFO_ENDIANESS</glossterm> |
| 845 | <glossdef> | 889 | <glossdef> |
| 846 | <para> | 890 | <para> |
| 847 | Contains "le" for little-endian or "be" for big-endian depending | 891 | Specifies the endian byte order of the target system. |
| 848 | on the endian byte order of the target system. | 892 | The variable is either "le" for little-endian or "be" for big-endian. |
| 849 | </para> | 893 | </para> |
| 850 | </glossdef> | 894 | </glossdef> |
| 851 | </glossentry> | 895 | </glossentry> |
| @@ -853,27 +897,27 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 853 | <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> | 897 | <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> |
| 854 | <glossdef> | 898 | <glossdef> |
| 855 | <para> | 899 | <para> |
| 856 | Contains "32" or "64" depending on the number of bits for the | 900 | Specifies the number of bits for the target system CPU. |
| 857 | CPU of the target system. | 901 | The variable is either "32" or "64". |
| 858 | </para> | 902 | </para> |
| 859 | </glossdef> | 903 | </glossdef> |
| 860 | </glossentry> | 904 | </glossentry> |
| 861 | 905 | ||
| 862 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> | 906 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> |
| 863 | <glossdef> | 907 | <glossdef> |
| 864 | <para>List of source files (local or remote ones)</para> | 908 | <para>The list of source files - local or remote.</para> |
| 865 | </glossdef> | 909 | </glossdef> |
| 866 | </glossentry> | 910 | </glossentry> |
| 867 | 911 | ||
| 868 | <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> | 912 | <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> |
| 869 | <glossdef> | 913 | <glossdef> |
| 870 | <para> | 914 | <para> |
| 871 | By default there is code which automatically detects whether | 915 | By default, the Yocto Project automatically detects whether |
| 872 | <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> | 916 | <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> |
| 873 | contains files which are machine specific and if this is the case it | 917 | contains files that are machine-specific. |
| 874 | automatically changes | 918 | If so, the Yocto Project automatically changes |
| 875 | <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm>. | 919 | <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. |
| 876 | Setting this variable to "0" disables that behaviour. | 920 | Setting this variable to "0" disables this behaviour. |
| 877 | </para> | 921 | </para> |
| 878 | </glossdef> | 922 | </glossdef> |
| 879 | </glossentry> | 923 | </glossentry> |
| @@ -881,8 +925,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 881 | <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> | 925 | <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> |
| 882 | <glossdef> | 926 | <glossdef> |
| 883 | <para> | 927 | <para> |
| 884 | Date of source code used to build package (if it was fetched | 928 | The date of the source code used to build the package. |
| 885 | from SCM). | 929 | This variable applies only if the source was fetched from a Source Code Manager (SCM). |
| 886 | </para> | 930 | </para> |
| 887 | </glossdef> | 931 | </glossdef> |
| 888 | </glossentry> | 932 | </glossentry> |
| @@ -890,8 +934,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 890 | <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> | 934 | <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> |
| 891 | <glossdef> | 935 | <glossdef> |
| 892 | <para> | 936 | <para> |
| 893 | Revision of source code used to build package (Subversion, | 937 | The revision of the source code used to build the package. |
| 894 | GIT, Bazaar only). | 938 | This variable applies to Subversion, GitT, or Bazaar only. |
| 895 | </para> | 939 | </para> |
| 896 | </glossdef> | 940 | </glossdef> |
| 897 | </glossentry> | 941 | </glossentry> |
| @@ -899,7 +943,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 899 | <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> | 943 | <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> |
| 900 | <glossdef> | 944 | <glossdef> |
| 901 | <para> | 945 | <para> |
| 902 | Directory with kernel headers required to build out-of-tree | 946 | The directory with kernel headers that are required to build out-of-tree |
| 903 | modules. | 947 | modules. |
| 904 | </para> | 948 | </para> |
| 905 | </glossdef> | 949 | </glossdef> |
| @@ -908,7 +952,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 908 | <glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm> | 952 | <glossentry id='var-STAMPS'><glossterm>STAMPS</glossterm> |
| 909 | <glossdef> | 953 | <glossdef> |
| 910 | <para> | 954 | <para> |
| 911 | Directory (usually TMPDIR/stamps) with timestamps of | 955 | The directory (usually <filename>TMPDIR/stamps</filename>) with timestamps of |
| 912 | executed tasks. | 956 | executed tasks. |
| 913 | </para> | 957 | </para> |
| 914 | </glossdef> | 958 | </glossdef> |
| @@ -916,7 +960,10 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 916 | 960 | ||
| 917 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> | 961 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> |
| 918 | <glossdef> | 962 | <glossdef> |
| 919 | <para>Short (72 char suggested) Summary of binary package for packaging systems such as ipkg, rpm or debian, inherits DESCRIPTION by default</para> | 963 | <para>The short (72 characters or less) summary of the binary package for packaging |
| 964 | systems such as <filename>ipkg</filename>, <filename>rpm</filename> or | ||
| 965 | <filename>debian</filename>. | ||
| 966 | By default, this variable inherits <filename>DESCRIPTION</filename>.</para> | ||
| 920 | </glossdef> | 967 | </glossdef> |
| 921 | </glossentry> | 968 | </glossentry> |
| 922 | 969 | ||
| @@ -926,17 +973,18 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 926 | 973 | ||
| 927 | <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> | 974 | <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> |
| 928 | <glossdef> | 975 | <glossdef> |
| 929 | <para>The architecture of the device we're building for. | 976 | <para>The architecture of the device being built. |
| 930 | A number of values are possible but Poky primarily supports | 977 | While a number of values are possible, the Yocto Project primarily supports |
| 931 | "arm" and "i586".</para> | 978 | <filename>arm</filename> and <filename>i586</filename>.</para> |
| 932 | </glossdef> | 979 | </glossdef> |
| 933 | </glossentry> | 980 | </glossentry> |
| 934 | 981 | ||
| 935 | <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> | 982 | <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> |
| 936 | <glossdef> | 983 | <glossdef> |
| 937 | <para> | 984 | <para> |
| 938 | Flags passed to C compiler for the target system. Evaluates to the same | 985 | Flags passed to the C compiler for the target system. |
| 939 | as <link linkend='var-CFLAGS'>CFLAGS</link>. | 986 | This variable evaluates to the same as |
| 987 | <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>. | ||
| 940 | </para> | 988 | </para> |
| 941 | </glossdef> | 989 | </glossdef> |
| 942 | </glossentry> | 990 | </glossentry> |
| @@ -944,29 +992,45 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 944 | 992 | ||
| 945 | <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> | 993 | <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> |
| 946 | <glossdef> | 994 | <glossdef> |
| 947 | <para>Method of handling FPU code. For FPU-less targets | 995 | <para>Specifies the method for handling FPU code. |
| 948 | (most of ARM cpus) it has to be set to "soft" otherwise | 996 | For FPU-less targets, which include most ARM CPUs, the variable must be |
| 949 | kernel emulation will get used which will result in | 997 | set to "soft". |
| 950 | performance penalty.</para> | 998 | If not, the kernel emulation gets used, which results in a performance penalty.</para> |
| 951 | </glossdef> | 999 | </glossdef> |
| 952 | </glossentry> | 1000 | </glossentry> |
| 953 | 1001 | ||
| 954 | <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> | 1002 | <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> |
| 955 | <glossdef> | 1003 | <glossdef> |
| 956 | <para>Type of target operating system. Can be "linux" | 1004 | <para>Specifies the target's operating system. |
| 957 | for glibc based system, "linux-uclibc" for uClibc. For | 1005 | The variable can be set to "linux" for <filename>glibc</filename>-based systems and |
| 958 | ARM/EABI targets there are also "linux-gnueabi" and | 1006 | "linux-uclibc" for <filename>uClibc</filename>. |
| 959 | "linux-uclibc-gnueabi" values possible.</para> | 1007 | For ARM/EABI targets, there are also "linux-gnueabi" and |
| 1008 | "linux-uclibc-gnueabi" values possible.</para> | ||
| 960 | </glossdef> | 1009 | </glossdef> |
| 961 | </glossentry> | 1010 | </glossentry> |
| 962 | 1011 | ||
| 1012 | <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> | ||
| 1013 | <glossdef> | ||
| 1014 | <para>The toolchain selector. | ||
| 1015 | This variable replaces <filename>POKYMODE</filename>. | ||
| 1016 | The variable determines which of the files in | ||
| 1017 | <filename>meta/conf/distro/include/tcmode-*</filename> is used. | ||
| 1018 | By default, <filename>TCMODE</filename> is set to "default", which | ||
| 1019 | chooses <filename>tcmode-default.inc</filename>.</para> | ||
| 1020 | <para>The variable is similar to <filename>TCLIBC</filename>, which controls the | ||
| 1021 | <filename>libc</filename> used: <filename>eglibc</filename> or <filename>uclibc</filename>. | ||
| 1022 | </para> | ||
| 1023 | </glossdef> | ||
| 1024 | </glossentry> | ||
| 1025 | |||
| 963 | <glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm> | 1026 | <glossentry id='var-TERMCMD'><glossterm>TERMCMD</glossterm> |
| 964 | <glossdef> | 1027 | <glossdef> |
| 965 | <para> | 1028 | <para> |
| 966 | This command is used by bitbake to lauch a terminal window with a | 1029 | This command is used by BitBake to lauch a terminal window with a |
| 967 | shell. The shell is unspecified so the user's default shell is used. | 1030 | shell. |
| 968 | By default it is set to <command>gnome-terminal</command> but it can | 1031 | The shell is unspecified so the user's default shell is used. |
| 969 | be any X11 terminal application or terminal multiplexers like screen. | 1032 | By default, the variable is set to <filename>gnome-terminal</filename> but it can |
| 1033 | be any X11 terminal application or terminal multiplexers-like screen. | ||
| 970 | </para> | 1034 | </para> |
| 971 | </glossdef> | 1035 | </glossdef> |
| 972 | </glossentry> | 1036 | </glossentry> |
| @@ -974,9 +1038,11 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 974 | <glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm> | 1038 | <glossentry id='var-TERMCMDRUN'><glossterm>TERMCMDRUN</glossterm> |
| 975 | <glossdef> | 1039 | <glossdef> |
| 976 | <para> | 1040 | <para> |
| 977 | This command is similar to <glossterm><link | 1041 | This variable is similar to |
| 978 | linkend='var-TERMCMD'>TERMCMD</link></glossterm> however instead of the users shell it runs the command specified by the <glossterm><link | 1042 | <filename><link linkend='var-TERMCMD'>TERMCMD</link></filename>. |
| 979 | linkend='var-SHELLCMDS'>SHELLCMDS</link></glossterm> variable. | 1043 | However, instead of running the user's shell, the command specified by |
| 1044 | the <filename><link linkend='var-SHELLCMDS'>SHELLCMDS</link></filename> | ||
| 1045 | variable is run. | ||
| 980 | </para> | 1046 | </para> |
| 981 | </glossdef> | 1047 | </glossdef> |
| 982 | </glossentry> | 1048 | </glossentry> |
| @@ -993,8 +1059,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0" | |||
| 993 | 1059 | ||
| 994 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | 1060 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> |
| 995 | <glossdef> | 1061 | <glossdef> |
| 996 | <para>Path to directory in tmp/work/ where package | 1062 | <para>The path to directory in <filename>tmp/work/</filename> where |
| 997 | will be built.</para> | 1063 | the package is built.</para> |
| 998 | </glossdef> | 1064 | </glossdef> |
| 999 | </glossentry> | 1065 | </glossentry> |
| 1000 | 1066 | ||
