meta/conf/documentation.conf

3 # Mail your changes to openembedded-devel@openembedded.org
8 do_build[doc] = "Default task for a recipe - depends on all other normal tasks required to 'build' …
9 do_bundle_initramfs[doc] = "Combines an initial ramdisk image and kernel together to form a single …
19 do_deploy[doc] = "Writes deployable output files to the deploy directory"
24 do_install[doc] = "Copies files from the compilation directory to a holding area"
25 do_install_ptest_base[doc] = "Copies the runtime test suite files from the compilation directory to…
39 do_packagedata[doc] = "Creates package metadata used by the build system to generate the final pack…
40 do_patch[doc] = "Locates patch files and applies them to the source code"
43 …bset of files installed by do_install into the sysroot in order to make them available to other re…
49 …t takes the source code and scans it on a remote FOSSOLOGY server in order to produce an SPDX docu…
64 ALTERNATIVE_LINK_NAME[doc] = "Used by the alternatives system to map duplicated commands to actual …
65 ALTERNATIVE_PRIORITY[doc] = "Used by the alternatives system to create default priorities for dupli…
66 ALTERNATIVE_TARGET[doc] = "Used by the alternatives system to create default link locations for dup…
70 ASSUME_PROVIDED[doc] = "List of packages (recipes actually) that are assumed to be implicitly avail…
72 AUTHOR[doc] = "Email address used to contact the original author(s) in order to send patches and fo…
74 AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest so…
79 BAD_RECOMMENDATIONS[doc] = "A list of packages not to install despite being recommended by a recipe…
81 BB_DISKMON_DIRS[doc] = "Monitors disk space and available inodes during the build and allows you to…
82 BB_DISKMON_WARNINTERVAL[doc] = "Defines the disk space and free inode warning intervals. To set the…
83 BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_…
84 … should run in parallel at any one time. A good rule of thumb is to set this variable to twice the…
85 BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Com…
86 BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are used to find the o…
87 BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. Thi…
88 … priority for recipe files in each layer. Setting this variable allows you to prioritize a layer a…
89 BBFILES[doc] = "List of recipe files used by BitBake to build software."
92 BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblay…
94 BBPATH[doc] = "Used by BitBake to locate .bbclass and configuration files. This variable is analogo…
95 BBSERVER[doc] = "Points to the server that runs memory-resident BitBake."
102 BUILDDIR[doc] = "Points to the location of the Build Directory."
103 BUILDSTATS_BASE[doc] = "Points to the location of the directory that holds build statistics when yo…
104 BUSYBOX_SPLIT_SUID[doc] = "For the BusyBox recipe, specifies whether to split the output executable…
109 CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the…
111 … does not work for a recipe (and therefore the build system should not try to use it during do_con…
113 COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is w…
114 COMPATIBLE_HOST[doc] = "A regular expression that resolves to one or more hosts (when the recipe is…
115 COMPATIBLE_MACHINE[doc] = "A regular expression that resolves to one or more target machines with w…
116 COMPLEMENTARY_GLOB[doc] = "Defines wildcards to match when installing a list of complementary packa…
118 CONFIG_SITE[doc] = "A list of files that contains autoconf test results relevant to the current bui…
122 CORE_IMAGE_EXTRA_INSTALL[doc] = "Specifies the list of packages to be added to the image. You shoul…
125 CVE_CHECK_LAYER_EXCLUDELIST[doc] = "Defines which layers to exclude from cve-check scanning"
126 CVE_CHECK_LAYER_INCLUDELIST[doc] = "Defines which layers to include during cve-check scanning"
133 DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the val…
134 …ATION[doc] = "The options to pass in TARGET_CFLAGS and CFLAGS when compiling a system for debuggin…
137 …= "Points to the general area that the OpenEmbedded build system uses to place images, packages, S…
138 …E[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other ass…
139 DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary wo…
142 …c] = "Specifies a list of distro-specific packages to add to all images. The variable only applies…
143 DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images …
145 …to be added to DISTRO_FEATURES if not also present in DISTRO_FEATURES_BACKFILL_CONSIDERED. This va…
146 …es from DISTRO_FEATURES_BACKFILL that should not be backfilled (i.e. added to DISTRO_FEATURES) dur…
150 DISTROOVERRIDES[doc] = "Lists overrides specific to the current distribution. By default, the varia…
151 DL_DIR[doc] = "The central download directory used by the build process to store downloads. By defa…
157 EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude a recipe from world builds (i.e. bitbake worl…
158 EXTENDPE[doc] = "Used with file and pathnames to create a prefix for a recipe's version based on th…
160 EXTERNALSRC[doc] = "If externalsrc.bbclass is inherited, this variable points to the source tree, w…
161 EXTERNALSRC_BUILD[doc] = "If externalsrc.bbclass is inherited, this variable points to the director…
162 EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this…
163 …f recipes to build that do not provide packages for installing into the root filesystem. Use this …
167 …ass, this variable specifies additional configuration options you want to pass to the scons comman…
168 …ST[doc] = "Configuration variables or options you want to pass to qmake when the arguments need to…
169 …RE[doc] = "Configuration variables or options you want to pass to qmake when the arguments need to…
174 FEED_DEPLOYDIR_BASE_URI[doc] = "Allow to serve ipk deploy directory as an ad hoc feed (bogofeed). S…
179 FILESYSTEM_PERMS_TABLES[doc] = "Allows you to define your own file permissions settings table as pa…
180 …le specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'."
181 …e class, this variable identifies packages containing font files that need to be cached by Fontcon…
182 …MIZATION[doc]= "The options to pass in TARGET_CFLAGS and CFLAGS when compiling an optimized system…
186 …es for a package what parameters should be passed to the groupadd command if you wish to add a gro…
187 …specifies for a package what parameters should be passed to the groupmems command if you wish to m…
188 GRUB_GFXSERIAL[doc] = "Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and seri…
189 GRUB_OPTS[doc] = "Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuratio…
205 ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide."
207 …Identifies user classes that you do not want the Icecream distributed compile support to consider."
208 …Identifies user recipes that you do not want the Icecream distributed compile support to consider."
209 …tifies user recipes that use an empty PARALLEL_MAKE variable that you want to force remote distrib…
211 …les from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same na…
213 IMAGE_FEATURES[doc] = "The primary list of features to include in an image. Configure this variable…
214 IMAGE_FSTYPES[doc] = "Formats of root filesystem images that you want to have created."
215 IMAGE_FSTYPES_DEBUGFS[doc] = "Formats of the debug root filesystem images that you want to have cre…
216 IMAGE_GEN_DEBUGFS[doc] = "When set to '1', generate a companion debug object/source filesystem imag…
217 …LL[doc] = "Specifies the packages to install into an image. Image recipes set IMAGE_INSTALL to spe…
218 IMAGE_LINGUAS[doc] = "Specifies the list of locales to install into the image during the root files…
220 IMAGE_OVERHEAD_FACTOR[doc] = "Defines a multiplier that the build system applies to the initial ima…
222 IMAGE_POSTPROCESS_COMMAND[doc] = "Added by classes to run post processing commands once the OpenEmb…
224 …dditional free disk space created in the image in Kbytes. By default, this variable is set to '0'."
229 …lt dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS."
230 INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting pa…
231 INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable i…
232 …t will be inherited at the distribution level. It is unlikely that you want to edit this variable."
234 INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk …
235 INITSCRIPT_NAME[doc] = "The filename of the initialization script as installed to ${sysconfdir}/ini…
236 … recipes when using update-rc.d.bbclass. The variable is optional and defaults to the PN variable."
237 INITSCRIPT_PARAMS[doc] = "Specifies the options to pass to update-rc.d. The variable is mandatory a…
238 INSANE_SKIP[doc] = "Specifies the QA checks to skip for a specific package within a recipe."
239 IPK_FEED_URIS[doc] = "List of ipkg feed records to put into generated image."
244 KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel br…
245 … repository's default branch used to build the Linux kernel. Unless you specify otherwise, the var…
249 …GETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration …
250 …c] = "The list of types of kernel to build for a device, usually set by the machine configuration …
251 KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot"
252 KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find mod…
253 KERNEL_PACKAGE_NAME[doc] = "Name prefix for kernel packages. Defaults to 'kernel'."
254 KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the ST…
255 KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STA…
258 KTYPE[doc] = "Defines the kernel type to be used in assembling the configuration."
265 …ompiled library file (.so) that the debian class applies its naming policy to given a recipe that …
268 LICENSE_PATH[doc] = "Path to additional licenses used during the build."
269 LINUX_KERNEL_TYPE[doc] = "Defines the kernel type to be used in assembling the configuration."
272 …ing (e.g. en_US) will always be UTF-8, and non-UTF-8 encodings are renamed to, e.g., en_US.ISO-885…
273 LOG_DIR[doc] = "Specifies the directory to which the OpenEmbedded build system writes overall log f…
278 …es to install as part of the image being built. Because this is a 'machine essential' variable, th…
279 …es to install as part of the image being built. Because this is a 'machine essential' variable, th…
280 …list of machine-specific packages to install as part of the image being built that are not essenti…
281 MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the ima…
283 …to be added to MACHINE_FEATURES if not also present in MACHINE_FEATURES_BACKFILL_CONSIDERED. This …
284 …s from MACHINE_FEATURES_BACKFILL that should not be backfilled (i.e. added to MACHINE_FEATURES) du…
285 MACHINEOVERRIDES[doc] = "Lists overrides specific to the current machine. By default, this list inc…
288 MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or…
289 …[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation…
295 …to '1', no recommended packages will be installed. Realize that some recommended packages might be…
299 …binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command."
300 OE_IMPORTS[doc] = "An internal variable used to tell the OpenEmbedded build system what Python modu…
304 OVERRIDES[doc] = "BitBake uses OVERRIDES to control what variables are overridden after BitBake par…
311 PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packa…
312 PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It …
313 PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required,…
315 PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is genera…
316 …NSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails t…
317 PACKAGE_SNAP_LIB_SYMLINKS[doc] = "Rename library files based on their SONAME to avoid an extra laye…
319 PACKAGES[doc] = "The list of packages to be created from the recipe."
321 PARALLEL_MAKE[doc] = "Specifies extra options that are passed to the make command during the compil…
322 …LLEL_MAKEINST[doc] = "Extra options passed to the make install command during the do_install task …
324 PATCHTOOL[doc] = "Specifies the utility used to apply patches for a recipe during do_patch."
325 PE[doc] = "The epoch of the recipe. The default value is '0'. The field is used to make upgrades po…
328 PKGD[doc] = "Points to the destination directory for files to be packaged before they are split int…
329 PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the…
330 PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split …
331 PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output fro…
332 …] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as …
341 PYPI_PACKAGE[doc] = "The python package name to use for fetching from pypi. Default is parsed from …
342 PYPI_PACKAGE_EXT[doc] = "The archive file extension to use for fetching from pypi. Default is tar.g…
343 PYPI_SRC_URI[doc] = "The URI to use to fetch from pypi, default uses pythonhosted.org and is constr…
347 QA_EMPTY_DIRS[doc] = "A list of directories that are expected to be empty."
349 QMAKE_PROFILES[doc] = "Specifies your own subset of .pro files to be built for use with qmake."
354 … dependencies (i.e. other packages) that must be installed for the package to be built. They must …
359 ROOTFS[doc] = "Indicates a filesystem image to include as the root filesystem."
360 ROOTFS_POSTPROCESS_COMMAND[doc] = "Added by classes to run post processing commands once the OpenEm…
362 … The package being built does not depend on this list of packages in order to successfully build, …
363 …y a package. The package manager uses this variable to determine which package should be installed…
371 SDK_DEPLOY[doc] = "The directory set up and used by the populate_sdk_base to which the SDK is deplo…
375 SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK g…
376 SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK and ADT …
379 …= "The speed and device for the serial port used to attach the serial console. This variable is gi…
380 SERIAL_CONSOLES[doc] = "Defines the serial consoles (TTYs) to enable using getty."
381 …IAL_CONSOLES_CHECK[doc] = "Similar to SERIAL_CONSOLES except the device is checked for existence b…
382 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that should not be used to de…
386 SKIP_RECIPE[doc] = "Lists recipes you do not want the OpenEmbedded build system to build."
390 SOURCE_MIRROR_FETCH[doc] = "Switch marking build as source fetcher. Used to skip COMPATIBLE_* check…
391 SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_…
392 …used by the OpenEmbedded build system to create variants of recipes or packages. The list specifie…
393 …his variable tells the OpenEmbedded build system what bits to pull in for the build and how to pul…
394 …the build system automatically changes PACKAGE_ARCH. Setting this variable to '0' disables this be…
395 SRCDATE[doc] = "The date of the source code used to build the package. This variable applies only i…
396 SRCPV[doc] = "Returns the version string of the current package. This string is used to help define…
397 SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to …
399 SSTATE_MIRRORS[doc] = "Configures the OpenEmbedded build system to search other mirror locations fo…
400 STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree…
401 STAMP[doc] = "Specifies the base path used to create recipe stamp files. The path to an actual stam…
403 …r packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTI…
405 SYSLINUX_OPTS[doc] = "Lists additional options to add to the syslinux file."
409 …ions to execute after files are staged into the sysroot. These functions are usually used to apply…
417 T[doc] = "This variable points to a directory were BitBake places temporary files, which consist mo…
419 TARGET_CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates…
420 …or FPU-less targets, which include most ARM CPUs, the variable must be set to 'soft'. If not, the …
424 TCLIBC[doc] = "Specifies C library (libc) variant to use during the build process. You can select '…
425 TCMODE[doc] = "Enables an external toolchain (where provided by an additional layer) if set to a va…
427 …OUT[doc] = "The time in seconds allowed for an image to boot before automated runtime tests begin …
428 TEST_SUITES[doc] = "An ordered list of tests (modules) to run against an image when performing auto…
429 TEST_POWERCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to contr…
430 … = "For automated hardware testing, specifies additional arguments to pass through to the command …
431 …CMD[doc] = "For automated hardware testing, specifies the command to use to connect to the serial …
432 … = "For automated hardware testing, specifies additional arguments to pass through to the command …
441 TUNE_PKGARCH[doc] = "The package architecture understood by the packaging system to define the arch…
450 UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image."
453 UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension."
455 …specifies to populate or not /dev. This variable defaults to '1' (leave directory empty, surely be…
456 USER_CLASSES[doc] = "List of additional classes to use when building images that enable extra featu…
457 …to 'error', forces the OpenEmbedded build system to produce an error if the user identification (u…
458 …ies a password file to use for obtaining static group identification (gid) values when the OpenEmb…
459 … specifies the individual packages within the recipe that require users and/or groups to be added."
460 …ies for a package what parameters should be passed to the useradd command if you wish to add a use…
461 …fies a password file to use for obtaining static user identification (uid) values when the OpenEmb…
462 USERADDEXTENSION[doc] = "When set to 'useradd-staticids', causes the OpenEmbedded build system to b…