diff options
Diffstat (limited to 'poky/documentation')
32 files changed, 1402 insertions, 1190 deletions
diff --git a/poky/documentation/Makefile b/poky/documentation/Makefile index 525a7309a..15644bf92 100644 --- a/poky/documentation/Makefile +++ b/poky/documentation/Makefile @@ -76,6 +76,11 @@ # example publishes the 1.2 version of the PDF and HTML YP Development Tasks Manual # for the 'denzil' branch. # +# IN MEMORIAM: This comment is to remember Scott Rifenbark (scottrif), whom we lost +# in January, 2020. Scott was the primary technical writer for the Yocto Project for +# over 9 years. In that time, he contributed many thousands of patches, built this +# documentation tree, and enabled tens of thousands of developers to succeed with +# embedded Linux. He ran this Makefile many thousands of times. Godspeed, Dude. ifeq ($(DOC),brief-yoctoprojectqs) XSLTOPTS = --stringparam html.stylesheet brief-yoctoprojectqs-style.css \ @@ -414,8 +419,8 @@ publish: echo " "; \ echo "******** Publishing "$(DOC)".html"; \ echo " "; \ - scp -r $(MANUALS) $(STYLESHEET) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ - cd $(DOC); scp -r $(FIGURES) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ + scp -r $(MANUALS) $(STYLESHEET) www.yoctoproject.org:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ + cd $(DOC); scp -r $(FIGURES) www.yoctoproject.org:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \ else \ echo " "; \ echo $(DOC)".html missing. Generate the file first then try again."; \ diff --git a/poky/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/poky/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml index 1daeb2547..3c83afd46 100644 --- a/poky/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml +++ b/poky/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml @@ -55,10 +55,18 @@ information. </para></listitem> <listitem><para> - You cannot use a build host that is using the - <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux</ulink> - (WSL). - The Yocto Project is not compatible with WSL. + You may use Windows Subsystem For Linux v2 to set up a build + host using Windows 10. + <note> + The Yocto Project is not compatible with WSLv1, it is + compatible but not officially supported nor validated + with WSLv2, if you still decide to use WSL please upgrade + to WSLv2. + </note> + See the + <ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-to-use-wsl'>Setting Up to Use Windows Subsystem For Linux</ulink>" + section in the Yocto Project Development Tasks Manual for more + information. </para></listitem> </itemizedlist> </note> @@ -99,17 +107,20 @@ Git 1.8.3.1 or greater </para></listitem> <listitem><para> - tar 1.27 or greater + tar 1.28 or greater </para></listitem> <listitem><para> - Python 3.4.0 or greater. - </para></listitem> + Python 3.5.0 or greater. + </para></listitem> + <listitem><para> + gcc 5.0 or greater. + </para></listitem> </itemizedlist> If your build host does not meet any of these three listed version requirements, you can take steps to prepare the system so that you can still use the Yocto Project. See the - "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>" + "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</ulink>" section in the Yocto Project Reference Manual for information. </para></listitem> </itemizedlist> @@ -266,7 +277,7 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' </literallayout> Among other things, the script creates the <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, @@ -332,7 +343,7 @@ QEMU, which is a Quick EMUlator that ships with the Yocto Project: <literallayout class='monospaced'> - $ runqemu qemux86 + $ runqemu qemux86-64 </literallayout> If you want to learn more about running QEMU, see the "<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>" diff --git a/poky/documentation/bsp-guide/bsp-guide.xml b/poky/documentation/bsp-guide/bsp-guide.xml index dd0c76add..a189606ce 100644..100755 --- a/poky/documentation/bsp-guide/bsp-guide.xml +++ b/poky/documentation/bsp-guide/bsp-guide.xml @@ -22,33 +22,27 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> <revhistory> <revision> <revnumber>0.9</revnumber> - <date>24 November 2010</date> - <revremark>The initial document draft released with the Yocto Project 0.9 Release.</revremark> + <date>November 2010</date> + <revremark>The initial document released with the Yocto Project 0.9 Release.</revremark> </revision> <revision> <revnumber>1.0</revnumber> - <date>6 April 2011</date> + <date>April 2011</date> <revremark>Released with the Yocto Project 1.0 Release.</revremark> </revision> <revision> - <revnumber>1.0.1</revnumber> - <date>23 May 2011</date> - <revremark>Released with the Yocto Project 1.0.1 Release.</revremark> - </revision> - <revision> <revnumber>1.1</revnumber> - <date>6 October 2011</date> + <date>October 2011</date> <revremark>Released with the Yocto Project 1.1 Release.</revremark> </revision> <revision> @@ -72,11 +66,6 @@ <revremark>Released with the Yocto Project 1.5 Release.</revremark> </revision> <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> <revnumber>1.6</revnumber> <date>April 2014</date> <revremark>Released with the Yocto Project 1.6 Release.</revremark> @@ -133,9 +122,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -157,7 +151,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -174,18 +168,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/bsp-guide/bsp.xml b/poky/documentation/bsp-guide/bsp.xml index 58f5733f7..96c0455f6 100644 --- a/poky/documentation/bsp-guide/bsp.xml +++ b/poky/documentation/bsp-guide/bsp.xml @@ -19,7 +19,7 @@ </para> <para> - This guide presents information about BSP Layers, defines a structure for components + This guide presents information about BSP layers, defines a structure for components so that BSPs follow a commonly understood layout, discusses how to customize a recipe for a BSP, addresses BSP licensing, and provides information that shows you how to create a @@ -34,7 +34,7 @@ <para> A BSP consists of a file structure inside a base directory. Collectively, you can think of the base directory, its file structure, - and the contents as a BSP Layer. + and the contents as a <firstterm>BSP layer</firstterm>. Although not a strict requirement, BSP layers in the Yocto Project use the following well-established naming convention: <literallayout class='monospaced'> @@ -69,9 +69,9 @@ Each repository is a BSP layer supported by the Yocto Project (e.g. <filename>meta-raspberrypi</filename> and <filename>meta-intel</filename>). - Each of these layers is a repository unto itself and clicking on a - layer reveals information that includes two links from which you can choose - to set up a clone of the layer's repository on your local host system. + Each of these layers is a repository unto itself and clicking on + the layer name displays two URLs from which you can + clone the layer's repository to your local system. Here is an example that clones the Raspberry Pi BSP layer: <literallayout class='monospaced'> $ git clone git://git.yoctoproject.org/meta-raspberrypi @@ -83,12 +83,13 @@ <filename>meta-yocto-bsp</filename> layer is part of the shipped <filename>poky</filename> repository. The <filename>meta-yocto-bsp</filename> layer maintains several - BSPs such as the Beaglebone, EdgeRouter, and generic versions of + "reference" BSPs including the ARM-based Beaglebone, MIPS-based + EdgeRouter, and generic versions of both 32-bit and 64-bit IA machines. </para> <para> - For information on the BSP development workflow, see the + For information on typical BSP development workflow, see the "<link linkend='developing-a-board-support-package-bsp'>Developing a Board Support Package (BSP)</link>" section. For more information on how to set up a local copy of source files @@ -98,12 +99,12 @@ </para> <para> - The layer's base directory + The BSP layer's base directory (<filename>meta-<replaceable>bsp_root_name</replaceable></filename>) - is the root directory of the BSP Layer. + is the root directory of that Layer. This directory is what you add to the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> - variable in the <filename>conf/bblayers.conf</filename> file found in the + variable in the <filename>conf/bblayers.conf</filename> file found in your <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, which is established after you run the OpenEmbedded build environment setup script (i.e. @@ -153,6 +154,20 @@ layer. The <filename>meta-openembedded</filename> layer contains many <filename>meta-*</filename> layers. + In cases like this, you need to include the names of the actual + layers you want to work with, such as: + <literallayout class='monospaced'> + BBLAYERS ?= " \ + /usr/local/src/yocto/meta \ + /usr/local/src/yocto/meta-poky \ + /usr/local/src/yocto/meta-yocto-bsp \ + /usr/local/src/yocto/meta-mylayer \ + .../meta-openembedded/meta-oe \ + .../meta-openembedded/meta-perl \ + .../meta-openembedded/meta-networking \ + " + </literallayout> + and so on. </para> <para> @@ -351,25 +366,24 @@ layer combined with a build system and other tools. Realize that it is important to maintain the distinction that the BSP layer, a build system, and tools are - separate components that could to be combined in + separate components that could be combined in certain end products. </para> <para> - Before looking at the common form for the file structure - inside a BSP Layer, you should be aware that some + Before looking at the recommended form for the directory structure + inside a BSP layer, you should be aware that some requirements do exist in order for a BSP layer to - be considered compliant with the Yocto Project. + be considered <firstterm>compliant</firstterm> with the Yocto Project. For that list of requirements, see the "<link linkend='released-bsp-requirements'>Released BSP Requirements</link>" section. </para> <para> - Below is the common form for the file structure - inside a BSP Layer. + Below is the typical directory structure for a BSP layer. While this basic form represents the standard, - realize that the actual file structures for specific + realize that the actual layout for individual BSPs could differ. <literallayout class='monospaced'> meta-<replaceable>bsp_root_name</replaceable>/ @@ -567,7 +581,7 @@ for the BSP. The type or types of files here can vary depending on the licensing requirements. - For example, in the Raspberry Pi BSP all licensing + For example, in the Raspberry Pi BSP, all licensing requirements are handled with the <filename>COPYING.MIT</filename> file. </para> @@ -802,7 +816,7 @@ <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. For example, many <filename>tune-*</filename> files (e.g. <filename>tune-arm1136jf-s.inc</filename>, - <filename>tun-1586-nlp.inc</filename>, and so forth) + <filename>tune-1586-nlp.inc</filename>, and so forth) reside in the <filename>poky/meta/conf/machine/include</filename> directory. @@ -834,7 +848,7 @@ This optional directory contains miscellaneous recipe files for the BSP. Most notably would be the formfactor files. - For example, in the Raspberry Pi BSP there is the + For example, in the Raspberry Pi BSP, there is the <filename>formfactor_0.0.bbappend</filename> file, which is an append file used to augment the recipe that starts the build. @@ -901,7 +915,7 @@ The <filename>*.bb</filename> files would be a developer-supplied kernel recipe. This area of the BSP hierarchy can contain both these - types of files, although in practice, it is likely that + types of files although, in practice, it is likely that you would have one or the other. </para> @@ -976,7 +990,7 @@ <title>Developing a Board Support Package (BSP)</title> <para> - This section contains the high-level procedure you can + This section describes the high-level procedure you can follow to create a BSP. Although not required for BSP creation, the <filename>meta-intel</filename> repository, which @@ -1075,10 +1089,6 @@ (<filename>beaglebone-yocto</filename>) </para></listitem> <listitem><para> - Freescale MPC8315E-RDB - (<filename>mpc8315e-rdb</filename>) - </para></listitem> - <listitem><para> Ubiquiti Networks EdgeRouter Lite (<filename>edgerouter</filename>) </para></listitem> @@ -1302,7 +1312,7 @@ (<filename>openembedded-core</filename>) or the Source Directory (<filename>poky</filename>). In other words, make sure you place related - files in appropriately related + files in appropriately-related <filename>recipes-*</filename> subdirectories specific to the recipe's function, or within a subdirectory containing a set of closely-related @@ -1319,7 +1329,7 @@ directory. This license covers the BSP Metadata as a whole. You must specify which license to use since no - default license exists when one not specified. + default license exists when one is not specified. See the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/COPYING.MIT'><filename>COPYING.MIT</filename></ulink> file for the Raspberry Pi BSP in the @@ -1342,12 +1352,10 @@ file should contain the following: <itemizedlist> <listitem><para> - A brief description about the hardware the BSP - targets. + A brief description of the target hardware. </para></listitem> <listitem><para> - A list of all the dependencies - on which a BSP layer depends. + A list of all the dependencies of the BSP. These dependencies are typically a list of required layers needed to build the BSP. @@ -1610,7 +1618,7 @@ <title>BSP Licensing Considerations</title> <para> - In some cases, a BSP contains separately licensed + In some cases, a BSP contains separately-licensed Intellectual Property (IP) for a component or components. For these cases, you are required to accept the terms of a commercial or other type of license that requires @@ -1623,7 +1631,7 @@ </para> <para> - You could find that some separately licensed components + You could find that some separately-licensed components that are essential for normal operation of the system might not have an unencumbered (or free) substitute. Without these essential components, the system would be @@ -1631,7 +1639,7 @@ Then again, you might find that other licensed components that are simply 'good-to-have' or purely elective do have an unencumbered, free replacement component that you can - use rather than agreeing to the separately licensed + use rather than agreeing to the separately-licensed component. Even for components essential to the system, you might find an unencumbered component that is not identical but @@ -1744,7 +1752,7 @@ <para> The <filename>bitbake-layers create-layer</filename> script automates creating a BSP layer. - What makes a layer a "BSP layer", is the presence of a machine + What makes a layer a "BSP layer" is the presence of at least one machine configuration file. Additionally, a BSP layer usually has a kernel recipe or an append file that leverages off an existing kernel recipe. @@ -1868,11 +1876,14 @@ </para> <para> - Machine configuration files exist in the + One or more machine configuration files exist in the <replaceable>bsp_layer</replaceable><filename>/conf/machine/</filename> directory of the layer: <literallayout class='monospaced'> - <replaceable>bsp_layer</replaceable><filename>/conf/machine/</filename><replaceable>machine</replaceable><filename>.conf</filename> + <replaceable>bsp_layer</replaceable><filename>/conf/machine/</filename><replaceable>machine1</replaceable><filename>.conf</filename> + <replaceable>bsp_layer</replaceable><filename>/conf/machine/</filename><replaceable>machine2</replaceable><filename>.conf</filename> + <replaceable>bsp_layer</replaceable><filename>/conf/machine/</filename><replaceable>machine3</replaceable><filename>.conf</filename> + ... more ... </literallayout> For example, the machine configuration file for the <ulink url='http://beagleboard.org/bone'>BeagleBone and BeagleBone Black development boards</ulink> @@ -1923,8 +1934,8 @@ IMAGE_BOOT_FILES ?= "u-boot.${UBOOT_SUFFIX} MLO zImage am335x-bone.dtb am335x-boneblack.dtb am335x-bonegreen.dtb" </literallayout> The variables used to configure the machine define - machine-specific properties. - For example, machine-dependent packages, machine + machine-specific properties; + for example, machine-dependent packages, machine tunings, the type of kernel to build, and U-Boot configurations. </para> @@ -1935,7 +1946,7 @@ machine configuration file for the BeagleBone development boards. Realize that much more can be defined as part of - a machines configuration file. + a machine's configuration file. In general, you can learn about related variables that this example does not have by locating the variables in the @@ -2182,7 +2193,6 @@ KBRANCH_genericx86-64 = "v5.0/standard/base" KBRANCH_edgerouter = "v5.0/standard/edgerouter" KBRANCH_beaglebone-yocto = "v5.0/standard/beaglebone" - KBRANCH_mpc8315e-rdb = "v5.0/standard/fsl-mpc8315e-rdb" KMACHINE_genericx86 ?= "common-pc" KMACHINE_genericx86-64 ?= "common-pc-64" @@ -2192,19 +2202,16 @@ SRCREV_machine_genericx86-64 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" SRCREV_machine_edgerouter ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" SRCREV_machine_beaglebone-yocto ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine_mpc8315e-rdb ?= "8b62af7f252af10588276802c4c6d7c502e875be" COMPATIBLE_MACHINE_genericx86 = "genericx86" COMPATIBLE_MACHINE_genericx86-64 = "genericx86-64" COMPATIBLE_MACHINE_edgerouter = "edgerouter" COMPATIBLE_MACHINE_beaglebone-yocto = "beaglebone-yocto" - COMPATIBLE_MACHINE_mpc8315e-rdb = "mpc8315e-rdb" LINUX_VERSION_genericx86 = "5.0.3" LINUX_VERSION_genericx86-64 = "5.0.3" LINUX_VERSION_edgerouter = "5.0.3" LINUX_VERSION_beaglebone-yocto = "5.0.3" - LINUX_VERSION_mpc8315e-rdb = "5.0.3" </literallayout> This particular append file works for all the machines that are part of the diff --git a/poky/documentation/dev-manual/dev-manual-common-tasks.xml b/poky/documentation/dev-manual/dev-manual-common-tasks.xml index 00741ee45..605d1ad7e 100644 --- a/poky/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/poky/documentation/dev-manual/dev-manual-common-tasks.xml @@ -184,6 +184,10 @@ variable. </para></listitem> <listitem><para> + <ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></ulink>: + Lists all layers on which this layer depends (if any). + </para></listitem> + <listitem><para> <ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERSERIES_COMPAT'><filename>LAYERSERIES_COMPAT</filename></ulink>: Lists the <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Yocto Project</ulink> @@ -315,12 +319,26 @@ DEPENDS_append_one = " foo" DEPENDS_prepend_one = "foo " </literallayout> - As an actual example, here's a line from the recipe - for gnutls, which adds dependencies on - "argp-standalone" when building with the musl C - library: + As an actual example, here's a snippet from the + generic kernel include file + <filename>linux-yocto.inc</filename>, + wherein the kernel compile and link options are + adjusted in the case of a subset of the supported + architectures: <literallayout class='monospaced'> - DEPENDS_append_libc-musl = " argp-standalone" + DEPENDS_append_aarch64 = " libgcc" + KERNEL_CC_append_aarch64 = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD_append_aarch64 = " ${TOOLCHAIN_OPTIONS}" + + DEPENDS_append_nios2 = " libgcc" + KERNEL_CC_append_nios2 = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD_append_nios2 = " ${TOOLCHAIN_OPTIONS}" + + DEPENDS_append_arc = " libgcc" + KERNEL_CC_append_arc = " ${TOOLCHAIN_OPTIONS}" + KERNEL_LD_append_arc = " ${TOOLCHAIN_OPTIONS}" + + KERNEL_FEATURES_append_qemuall=" features/debug/printk.scc" </literallayout> <note> Avoiding "+=" and "=+" and using @@ -580,11 +598,19 @@ <filename>bitbake -e</filename>). </para></listitem> <listitem><para> + <filename>common.test_world</filename>: + Verifies that <filename>bitbake world</filename> works. + </para></listitem> + <listitem><para> <filename>common.test_signatures</filename>: Tests to be sure that BSP and DISTRO layers do not come with recipes that change signatures. </para></listitem> <listitem><para> + <filename>common.test_layerseries_compat</filename>: + Verifies layer compatibility is set properly. + </para></listitem> + <listitem><para> <filename>bsp.test_bsp_defines_machines</filename>: Tests if a BSP layer has machine configurations. </para></listitem> @@ -594,11 +620,22 @@ machine when the layer is added. </para></listitem> <listitem><para> + <filename>bsp.test_machine_world</filename>: + Verifies that <filename>bitbake world</filename> + works regardless of which machine is selected. + </para></listitem> + <listitem><para> + <filename>bsp.test_machine_signatures</filename>: + Verifies that building for a particular machine + affects only the signature of tasks specific to that + machine. + </para></listitem> + <listitem><para> <filename>distro.test_distro_defines_distros</filename>: Tests if a DISTRO layer has distro configurations. </para></listitem> <listitem><para> - <filename>distro.test_distro_no_set_distro</filename>: + <filename>distro.test_distro_no_set_distros</filename>: Tests to ensure a DISTRO layer does not set the distribution when the layer is added. </para></listitem> @@ -1397,7 +1434,7 @@ package specified in the <filename>PACKAGES</filename> statement. <note> - The <filename>inherit packages</filename> should be + The <filename>inherit packagegroup</filename> line should be located near the top of the recipe, certainly before the <filename>PACKAGES</filename> statement. </note> @@ -1417,28 +1454,32 @@ <para> Here is a short, fabricated example showing the same basic - pieces: + pieces for a hypothetical packagegroup defined in + <filename>packagegroup-custom.bb</filename>, where the + variable <filename>PN</filename> is the standard way to + abbreviate the reference to the full packagegroup name + <filename>packagegroup-custom</filename>: <literallayout class='monospaced'> DESCRIPTION = "My Custom Package Groups" inherit packagegroup PACKAGES = "\ - packagegroup-custom-apps \ - packagegroup-custom-tools \ + ${PN}-apps \ + ${PN}-tools \ " - RDEPENDS_packagegroup-custom-apps = "\ + RDEPENDS_${PN}-apps = "\ dropbear \ portmap \ psplash" - RDEPENDS_packagegroup-custom-tools = "\ + RDEPENDS_${PN}-tools = "\ oprofile \ oprofileui-server \ lttng-tools" - RRECOMMENDS_packagegroup-custom-tools = "\ + RRECOMMENDS_${PN}-tools = "\ kernel-module-oprofile" </literallayout> </para> @@ -1900,9 +1941,9 @@ <para> The <filename>SRC_URI</filename> variable in your recipe must define each unique location for your source files. - It is good practice to not hard-code pathnames in an URL used + It is good practice to not hard-code version numbers in a URL used in <filename>SRC_URI</filename>. - Rather than hard-code these paths, use + Rather than hard-code these values, use <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink><filename>}</filename>, which causes the fetch process to use the version specified in the recipe filename. @@ -1913,13 +1954,13 @@ <para> Here is a simple example from the - <filename>meta/recipes-devtools/cdrtools/cdrtools-native_3.01a20.bb</filename> + <filename>meta/recipes-devtools/strace/strace_5.5.bb</filename> recipe where the source comes from a single tarball. Notice the use of the <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> variable: <literallayout class='monospaced'> - SRC_URI = "ftp://ftp.berlios.de/pub/cdrecord/alpha/cdrtools-${PV}.tar.bz2" + SRC_URI = "https://strace.io/files/${PV}/strace-${PV}.tar.xz \ </literallayout> </para> @@ -1978,16 +2019,17 @@ For these cases, you provide a name for each URL as part of the <filename>SRC_URI</filename> and then reference that name in the subsequent checksum statements. - Here is an example: + Here is an example combining lines from the files + <filename>git.inc</filename> and + <filename>git_2.24.1.bb</filename>: <literallayout class='monospaced'> - SRC_URI = "${DEBIAN_MIRROR}/main/a/apmd/apmd_3.2.2.orig.tar.gz;name=tarball \ - ${DEBIAN_MIRROR}/main/a/apmd/apmd_${PV}.diff.gz;name=patch" - - SRC_URI[tarball.md5sum] = "b1e6309e8331e0f4e6efd311c2d97fa8" - SRC_URI[tarball.sha256sum] = "7f7d9f60b7766b852881d40b8ff91d8e39fccb0d1d913102a5c75a2dbb52332d" + SRC_URI = "${KERNELORG_MIRROR}/software/scm/git/git-${PV}.tar.gz;name=tarball \ + ${KERNELORG_MIRROR}/software/scm/git/git-manpages-${PV}.tar.gz;name=manpages" - SRC_URI[patch.md5sum] = "57e1b689264ea80f78353519eece0c92" - SRC_URI[patch.sha256sum] = "7905ff96be93d725544d0040e425c42f9c05580db3c272f11cff75b9aa89d430" + SRC_URI[tarball.md5sum] = "166bde96adbbc11c8843d4f8f4f9811b" + SRC_URI[tarball.sha256sum] = "ad5334956301c86841eb1e5b1bb20884a6bad89a10a6762c958220c7cf64da02" + SRC_URI[manpages.md5sum] = "31c2272a8979022497ba3d4202df145d" + SRC_URI[manpages.sha256sum] = "9a7ae3a093bea39770eb96ca3e5b40bff7af0b9f6123f089d7821d0e5b8e1230" </literallayout> </para> @@ -3242,8 +3284,6 @@ The script defined in the post-installation function is called when the root filesystem is created. If the script succeeds, the package is marked as installed. - If the script fails, the package is marked as unpacked and - the script is executed when the image boots again. <note> Any RPM post-installation script that runs on the target should return a 0 exit code. @@ -3262,7 +3302,7 @@ mark post installs to defer to the target. You can use <filename>pkg_postinst_ontarget()</filename> or call - <filename>postinst-intercepts defer_to_first_boot</filename> + <filename>postinst_intercept delay_to_first_boot</filename> from <filename>pkg_postinst()</filename>. Any failure of a <filename>pkg_postinst()</filename> script (including exit 1) triggers an error during the @@ -7609,7 +7649,6 @@ available Wic images as follows: <literallayout class='monospaced'> $ wic list images - mpc8315e-rdb Create SD card image for MPC8315E-RDB genericx86 Create an EFI disk image for genericx86* beaglebone-yocto Create SD card image for Beaglebone edgerouter Create SD card image for Edgerouter @@ -7797,7 +7836,6 @@ files: <literallayout class='monospaced'> $ wic list images - mpc8315e-rdb Create SD card image for MPC8315E-RDB genericx86 Create an EFI disk image for genericx86* beaglebone-yocto Create SD card image for Beaglebone edgerouter Create SD card image for Edgerouter @@ -9019,6 +9057,9 @@ <listitem><para> <link linkend='creating-node-package-manager-npm-packages'>Creating node package manager (NPM) packages</link> </para></listitem> + <listitem><para> + <link linkend='adding-custom-metadata-to-packages'>Adding custom metadata to packages</link> + </para></listitem> </itemizedlist> </para> @@ -10550,7 +10591,7 @@ <filename>devtool</filename> and the NPM fetcher to create the recipe: <literallayout class='monospaced'> - $ devtool add "npm://registry.npmjs.org;name=cute-files;version=1.0.2" + $ devtool add "npm://registry.npmjs.org;package=cute-files;version=1.0.2" </literallayout> The <filename>devtool add</filename> command runs <filename>recipetool create</filename> and uses the @@ -10575,25 +10616,13 @@ </para> <para> - <filename>recipetool</filename> creates "shrinkwrap" and - "lockdown" files for your recipe. + <filename>recipetool</filename> creates a "shrinkwrap" file + for your recipe. Shrinkwrap files capture the version of all dependent modules. Many packages do not provide shrinkwrap files. <filename>recipetool</filename> create a shrinkwrap file as it runs. - You can replace the shrinkwrap file with your own file - by setting the <filename>NPM_SHRINKWRAP</filename> - variable. - </para> - - <para> - Lockdown files contain the checksum for each module - to determine if your users download the same files when - building with a recipe. - Lockdown files ensure that dependencies have not been - changed and that your NPM registry is still providing - the same file. <note> A package is created for each sub-module. This policy is the only practical way to have the @@ -10608,23 +10637,26 @@ <literallayout class='monospaced'> $ devtool edit-recipe cute-files SUMMARY = "Turn any folder on your computer into a cute file browser, available on the local network." - LICENSE = "BSD-3-Clause & Unknown & MIT & ISC" + LICENSE = "MIT & ISC & Unknown" LIC_FILES_CHKSUM = "file://LICENSE;md5=71d98c0a1db42956787b1909c74a86ca \ - file://node_modules/content-disposition/LICENSE;md5=c6e0ce1e688c5ff16db06b7259e9cd20 \ - file://node_modules/express/LICENSE;md5=5513c00a5c36cd361da863dd9aa8875d \ + file://node_modules/toidentifier/LICENSE;md5=1a261071a044d02eb6f2bb47f51a3502 \ + file://node_modules/debug/LICENSE;md5=ddd815a475e7338b0be7a14d8ee35a99 \ ... - SRC_URI = "npm://registry.npmjs.org;name=cute-files;version=${PV}" - NPM_SHRINKWRAP := "${THISDIR}/${PN}/npm-shrinkwrap.json" - NPM_LOCKDOWN := "${THISDIR}/${PN}/lockdown.json" + SRC_URI = " \ + npm://registry.npmjs.org/;package=cute-files;version=${PV} \ + npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ + " + + S = "${WORKDIR}/npm" + inherit npm - # Must be set after inherit npm since that itself sets S - S = "${WORKDIR}/npmpkg" - LICENSE_${PN}-content-disposition = "MIT" - ... - LICENSE_${PN}-express = "MIT" LICENSE_${PN} = "MIT" + LICENSE_${PN}-accepts = "MIT" + LICENSE_${PN}-array-flatten = "MIT" + ... + LICENSE_${PN}-vary = "MIT" </literallayout> Three key points exist in the previous example: <itemizedlist> @@ -10717,11 +10749,10 @@ However, the <filename>SRC_URI</filename> looks like the following: <literallayout class='monospaced'> - SRC_URI = "git://github.com/martinaglv/cute-files.git;protocol=https \ - npm://registry.npmjs.org;name=commander;version=2.9.0;subdir=node_modules/commander \ - npm://registry.npmjs.org;name=express;version=4.14.0;subdir=node_modules/express \ - npm://registry.npmjs.org;name=content-disposition;version=0.3.0;subdir=node_modules/content-disposition \ - " + SRC_URI = " \ + git://github.com/martinaglv/cute-files.git;protocol=https \ + npmsw://${THISDIR}/${BPN}/npm-shrinkwrap.json \ + " </literallayout> In this example, the main module is taken from the Git repository and dependents are taken from the NPM registry. @@ -10733,6 +10764,61 @@ </para> </section> </section> + + <section id='adding-custom-metadata-to-packages'> + <title>Adding custom metadata to packages</title> + + <para> + The variable <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ADD_METADATA'><filename>PACKAGE_ADD_METADATA</filename></ulink> + can be used to add additional metadata to packages. This is + reflected in the package control/spec file. To take the ipk + format for example, the CONTROL file stored inside would + contain the additional metadata as additional lines. + </para> + + <para> + The variable can be used in multiple ways, including using + suffixes to set it for a specific package type and/or package. + Note that the order of precedence is the same as this list: + <itemizedlist> + <listitem><para> + <filename>PACKAGE_ADD_METADATA_<PKGTYPE>_<PN></filename> + </para></listitem> + <listitem><para> + <filename>PACKAGE_ADD_METADATA_<PKGTYPE></filename> + </para></listitem> + <listitem><para> + <filename>PACKAGE_ADD_METADATA_<PN></filename> + </para></listitem> + <listitem><para> + <filename>PACKAGE_ADD_METADATA</filename> + </para></listitem> + </itemizedlist> + <PKGTYPE> is a parameter and expected to be a + distinct name of specific package type: + <itemizedlist> + <listitem><para>IPK for .ipk packages</para></listitem> + <listitem><para>DEB for .deb packages</para></listitem> + <listitem><para>RPM for .rpm packages</para></listitem> + </itemizedlist> + <PN> is a parameter and expected to be a package name. + </para> + + <para> + The variable can contain multiple [one-line] metadata fields + separated by the literal sequence '\n'. The separator can be + redefined using the variable flag <filename>separator</filename>. + </para> + + <para> + The following is an example that adds two custom fields for + ipk packages: + <literallayout class='monospaced'> + PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup: Applications/Spreadsheets" + </literallayout> + </para> + </section> + </section> <section id='efficiently-fetching-source-files-during-a-build'> @@ -10822,7 +10908,7 @@ Use the following BitBake command form to fetch all the necessary sources without starting the build: <literallayout class='monospaced'> - $ bitbake -c <replaceable>target</replaceable> runall="fetch" + $ bitbake <replaceable>target</replaceable> --runall=fetch </literallayout> This variation of the BitBake command guarantees that you have all the sources for that BitBake target should you @@ -10845,15 +10931,6 @@ </para> <para> - By default, the Yocto Project uses SysVinit as the initialization - manager. - However, support also exists for systemd, - which is a full replacement for init with - parallel starting of services, reduced shell overhead and other - features that are used by many distributions. - </para> - - <para> Within the system, SysVinit treats system components as services. These services are maintained as shell scripts stored in the <filename>/etc/init.d/</filename> directory. @@ -11164,18 +11241,18 @@ <para> To create the read-only root filesystem, simply add the - "read-only-rootfs" feature to your image. - Using either of the following statements in your - image recipe or from within the - <filename>local.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> - causes the build system to create a read-only root filesystem: + "read-only-rootfs" feature to your image, normally in one of two ways. + The first way is to add the "read-only-rootfs" image feature + in the image's recipe file via the + <filename>IMAGE_FEATURES</filename> variable: <literallayout class='monospaced'> - IMAGE_FEATURES = "read-only-rootfs" + IMAGE_FEATURES += "read-only-rootfs" </literallayout> - or + As an alternative, you can add the same feature from within your + build directory's <filename>local.conf</filename> file with the + associated <filename>EXTRA_IMAGE_FEATURES</filename> variable, as in: <literallayout class='monospaced'> - EXTRA_IMAGE_FEATURES += "read-only-rootfs" + EXTRA_IMAGE_FEATURES = "read-only-rootfs" </literallayout> </para> @@ -12038,15 +12115,15 @@ In order to run tests on hardware, you need to set <filename>TEST_TARGET</filename> to an appropriate value. For QEMU, you do not have to change anything, the default - value is "QemuTarget". + value is "qemu". For running tests on hardware, the following options exist: <itemizedlist> - <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> - Choose "SimpleRemoteTarget" if you are going to + <listitem><para><emphasis>"simpleremote":</emphasis> + Choose "simpleremote" if you are going to run tests on a target system that is already running the image to be tested and is available on the network. - You can use "SimpleRemoteTarget" in conjunction + You can use "simpleremote" in conjunction with either real hardware or an image running within a separately started QEMU or any other virtual machine manager. @@ -12221,7 +12298,7 @@ <title>Power Control</title> <para> - For most hardware targets other than SimpleRemoteTarget, + For most hardware targets other than "simpleremote", you can control power: <itemizedlist> <listitem><para> @@ -12618,7 +12695,7 @@ <listitem><para><emphasis><filename>target</filename>:</emphasis> The target controller object used to deploy and start an image on a particular target - (e.g. QemuTarget, SimpleRemote, and + (e.g. Qemu, SimpleRemote, and SystemdbootTarget). Tests usually use the following: <itemizedlist> diff --git a/poky/documentation/dev-manual/dev-manual-qemu.xml b/poky/documentation/dev-manual/dev-manual-qemu.xml index f5a0d64af..5ccc0dfe8 100644 --- a/poky/documentation/dev-manual/dev-manual-qemu.xml +++ b/poky/documentation/dev-manual/dev-manual-qemu.xml @@ -151,13 +151,13 @@ <itemizedlist> <listitem><para> This example starts QEMU with - <replaceable>MACHINE</replaceable> set to "qemux86". + <replaceable>MACHINE</replaceable> set to "qemux86-64". Assuming a standard <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, <filename>runqemu</filename> automatically finds the - <filename>bzImage-qemux86.bin</filename> image file and + <filename>bzImage-qemux86-64.bin</filename> image file and the - <filename>core-image-minimal-qemux86-20140707074611.rootfs.ext3</filename> + <filename>core-image-minimal-qemux86-64-20200218002850.rootfs.ext4</filename> (assuming the current build created a <filename>core-image-minimal</filename> image). <note> @@ -166,7 +166,7 @@ timestamp. </note> <literallayout class='monospaced'> - $ runqemu qemux86 + $ runqemu qemux86-64 </literallayout> </para></listitem> <listitem><para> @@ -175,7 +175,7 @@ This command, however, specifically provides the image and root filesystem type. <literallayout class='monospaced'> - $ runqemu qemux86 core-image-minimal ext3 + $ runqemu qemux86-64 core-image-minimal ext4 </literallayout> </para></listitem> <listitem><para> @@ -188,7 +188,7 @@ be installed (see the previous description for the <filename>audio</filename> option for more information). <literallayout class='monospaced'> - $ runqemu qemux86 ramfs audio + $ runqemu qemux86-64 ramfs audio </literallayout> </para></listitem> <listitem><para> @@ -200,7 +200,7 @@ <replaceable>KERNEL</replaceable>, or <replaceable>VM</replaceable> option. <literallayout class='monospaced'> - $ runqemu ext3 + $ runqemu ext4 </literallayout> </para></listitem> <listitem><para> @@ -209,9 +209,9 @@ From the <filename>.wic.vmdk</filename>, <filename>runqemu</filename> determines the QEMU architecture (<replaceable>MACHINE</replaceable>) to be - "qemux86" and the root filesystem type to be "vmdk". + "qemux86-64" and the root filesystem type to be "vmdk". <literallayout class='monospaced'> - $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk + $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk </literallayout> </para></listitem> </itemizedlist> @@ -296,7 +296,7 @@ extracts it to a directory named <filename>test-nfs</filename>: <literallayout class='monospaced'> - runqemu-extract-sdk ./tmp/deploy/images/qemux86/core-image-sato-qemux86.tar.bz2 test-nfs + runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs </literallayout> </para></listitem> <listitem><para> @@ -310,7 +310,7 @@ Here is an example using the <filename>qemux86</filename> image: <literallayout class='monospaced'> - runqemu qemux86 ./test-nfs + runqemu qemux86-64 ./test-nfs </literallayout> </para></listitem> </orderedlist> diff --git a/poky/documentation/dev-manual/dev-manual-start.xml b/poky/documentation/dev-manual/dev-manual-start.xml index 59ffa49bb..8cb5631f0 100644 --- a/poky/documentation/dev-manual/dev-manual-start.xml +++ b/poky/documentation/dev-manual/dev-manual-start.xml @@ -7,7 +7,7 @@ <title>Setting Up to Use the Yocto Project</title> <para> - This chapter provides procedures related to getting set up to use the + This chapter provides guidance on how to prepare to use the Yocto Project. You can learn about creating a team environment that develops using the Yocto Project, how to set up a @@ -24,9 +24,9 @@ Project in a team development environment, or how to scale it for a large team of developers. You can adapt the Yocto Project to many different use cases and - scenarios. - However, this flexibility could cause difficulties if you are trying - to create a working setup that scales across a large team. + scenarios; + however, this flexibility could cause difficulties if you are trying + to create a working setup that scales effectively. </para> <para> @@ -35,17 +35,17 @@ that can help you get the results you want. The procedure is high-level and presents some of the project's most successful experiences, practices, solutions, and available - technologies that have proved to work well in the past. - Keep in mind, the procedure here is a starting point. + technologies that have proved to work well in the past; + however, keep in mind, the procedure here is simply a starting point. You can build off these steps and customize the procedure to fit any particular working environment and set of practices. <orderedlist> <listitem><para> <emphasis>Determine Who is Going to be Developing:</emphasis> - You need to understand who is going to be doing anything + You first need to understand who is going to be doing anything related to the Yocto Project and determine their roles. Making this determination is essential to completing - steps two and three, which are to get your equipment together + subsequent steps, which are to get your equipment together and set up your development environment's hardware topology. </para> @@ -64,8 +64,8 @@ <listitem><para> <emphasis>Build Engineer:</emphasis> This type of developer manages Autobuilders and - releases. - Not all environments need a Build Engineer. + releases. Depending on the specifics of the environment, + not all situations might need a Build Engineer. </para></listitem> <listitem><para> <emphasis>Test Engineer:</emphasis> @@ -88,6 +88,11 @@ You can help ensure efficiency by having any machines used for testing or that run Autobuilders be as high performance as possible. + <note> + Given sufficient processing power, you might also consider + building Yocto Project development containers to be run + under Docker, which is described later. + </note> </para></listitem> <listitem><para> <emphasis>Understand the Hardware Topology of the Environment:</emphasis> @@ -114,10 +119,10 @@ and any software you are developing under the control of an SCM system that is compatible with the OpenEmbedded build system is advisable. - Of the SCMs BitBake supports, the Yocto Project team strongly + Of all of the SCMs supported by BitBake, the Yocto Project team strongly recommends using <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>. - Git is a distributed system that is easy to backup, + Git is a distributed system that is easy to back up, allows you to work remotely, and then connects back to the infrastructure. <note> @@ -302,7 +307,7 @@ <para>As with any development environment, it is important to document the policy used as well as any main project guidelines so they are understood by everyone. - It is also a good idea to have well structured + It is also a good idea to have well-structured commit messages, which are usually a part of a project's guidelines. Good commit messages are essential when looking back in time and @@ -394,16 +399,18 @@ This section provides procedures to set up a system to be used as your <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink> for development using the Yocto Project. - Your build host can be a native Linux machine (recommended) or it can + Your build host can be a native Linux machine (recommended), it can be a machine (Linux, Mac, or Windows) that uses - <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>, + <ulink url='https://github.com/crops/poky-container'>CROPS</ulink>, which leverages - <ulink url='https://www.docker.com/'>Docker Containers</ulink>. + <ulink url='https://www.docker.com/'>Docker Containers</ulink> or it can + be a Windows machine capable of running Windows Subsystem For Linux v2 (WSL). <note> - You cannot use a build host that is using the - <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux</ulink> - (WSL). - The Yocto Project is not compatible with WSL. + The Yocto Project is not compatible with + <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux v1</ulink>. + It is compatible but not officially supported nor validated with WSLv2. + If you still decide to use WSL please upgrade to + <ulink url='https://docs.microsoft.com/en-us/windows/wsl/wsl2-install'>WSLv2</ulink>. </note> </para> @@ -442,7 +449,7 @@ You should have a reasonably current Linux-based host system. You will have the best results with a recent release of - Fedora, openSUSE, Debian, Ubuntu, or CentOS as these + Fedora, openSUSE, Debian, Ubuntu, RHEL or CentOS as these releases are frequently tested against the Yocto Project and officially supported. For a list of the distributions under validation and their @@ -460,23 +467,26 @@ <emphasis>Meet Minimal Version Requirements:</emphasis> The OpenEmbedded build system should be able to run on any modern distribution that has the following versions for - Git, tar, and Python. + Git, tar, Python and gcc. <itemizedlist> <listitem><para> Git 1.8.3.1 or greater </para></listitem> <listitem><para> - tar 1.27 or greater + tar 1.28 or greater </para></listitem> <listitem><para> - Python 3.4.0 or greater. - </para></listitem> + Python 3.5.0 or greater. + </para></listitem> + <listitem><para> + gcc 5.0 or greater. + </para></listitem> </itemizedlist> If your build host does not meet any of these three listed version requirements, you can take steps to prepare the system so that you can still use the Yocto Project. See the - "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>" + "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</ulink>" section in the Yocto Project Reference Manual for information. </para></listitem> @@ -517,7 +527,7 @@ <para> With - <ulink url='https://github.com/crops/crops/blob/master/README.md'>CROPS</ulink>, + <ulink url='https://github.com/crops/poky-container'>CROPS</ulink>, which leverages <ulink url='https://www.docker.com/'>Docker Containers</ulink>, you can create a Yocto Project development environment that @@ -654,15 +664,147 @@ section in the Toaster User Manual. </para> </section> + + <section id='setting-up-to-use-wsl'> + <title>Setting Up to Use Windows Subsystem For Linux (WSLv2)</title> + + <para> + With <ulink url='https://docs.microsoft.com/en-us/windows/wsl/wsl2-about'> + Windows Subsystem for Linux (WSLv2)</ulink>, you can create a + Yocto Project development environment that allows you to build + on Windows. You can set up a Linux distribution inside Windows + in which you can develop using the Yocto Project. + </para> + + <para> + Follow these general steps to prepare a Windows machine using WSLv2 + as your Yocto Project build host: + <orderedlist> + <listitem><para> + <emphasis>Make sure your Windows 10 machine is capable of running WSLv2:</emphasis> + + WSLv2 is only available for Windows 10 builds > 18917. To + check which build version you are running, you may open a + command prompt on Windows and execute the command "ver". + <literallayout class='monospaced'> + C:\Users\myuser> ver + + Microsoft Windows [Version 10.0.19041.153] + </literallayout> + If your build is capable of running WSLv2 you may continue, + for more information on this subject or instructions on how + to upgrade to WSLv2 visit <ulink url='https://docs.microsoft.com/en-us/windows/wsl/wsl2-install'>Windows 10 WSLv2</ulink> + </para></listitem> + <listitem><para> + <emphasis>Install the Linux distribution of your choice inside Windows 10:</emphasis> + Once you know your version of Windows 10 supports WSLv2, + you can install the distribution of your choice from the + Microsoft Store. + Open the Microsoft Store and search for Linux. While there + are several Linux distributions available, the assumption + is that your pick will be one of the distributions supported + by the Yocto Project as stated on the instructions for + using a native Linux host. + After making your selection, simply click "Get" to download + and install the distribution. + </para></listitem> + <listitem><para> + <emphasis>Check your Linux distribution is using WSLv2:</emphasis> + Open a Windows PowerShell and run: + <literallayout class='monospaced'> + C:\WINDOWS\system32> wsl -l -v + NAME STATE VERSION + *Ubuntu Running 2 + </literallayout> + Note the version column which says the WSL version being used by + your distribution, on compatible systems, this can be changed back + at any point in time. + </para></listitem> + <listitem><para> + <emphasis>Optionally Orient Yourself on WSL:</emphasis> + If you are unfamiliar with WSL, you can learn more here - + <ulink url='https://docs.microsoft.com/en-us/windows/wsl/wsl2-about'></ulink>. + </para></listitem> + <listitem><para> + <emphasis>Launch your WSL Distibution:</emphasis> + From the Windows start menu simply launch your WSL distribution + just like any other application. + </para></listitem> + <listitem><para> + <emphasis>Optimize your WSLv2 storage often:</emphasis> + Due to the way storage is handled on WSLv2, the storage + space used by the undelying Linux distribution is not + reflected immedately, and since bitbake heavily uses + storage, after several builds, you may be unaware you + are running out of space. WSLv2 uses a VHDX file for + storage, this issue can be easily avoided by manually + optimizing this file often, this can be done in the + following way: + <orderedlist> + <listitem><para> + <emphasis>Find the location of your VHDX file:</emphasis> + First you need to find the distro app package directory, + to achieve this open a Windows Powershell as Administrator + and run: + <literallayout class='monospaced'> + C:\WINDOWS\system32> Get-AppxPackage -Name "*Ubuntu*" | Select PackageFamilyName + PackageFamilyName + ----------------- + CanonicalGroupLimited.UbuntuonWindows_79abcdefgh + </literallayout> + You should now replace the <replaceable>PackageFamilyName</replaceable> + and your <replaceable>user</replaceable> on the following + path to find your VHDX file: <filename>C:\Users\user\AppData\Local\Packages\PackageFamilyName\LocalState\</filename> + For example: + <literallayout class='monospaced'> + ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ + Mode LastWriteTime Length Name + -a---- 3/14/2020 9:52 PM 57418973184 ext4.vhdx + </literallayout> + Your VHDX file path is: <filename>C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx</filename> + </para></listitem> + <listitem><para><emphasis>Optimize your VHDX file:</emphasis> + Open a Windows Powershell as Administrator to optimize + your VHDX file, shutting down WSL first: + <literallayout class='monospaced'> + C:\WINDOWS\system32> wsl --shutdown + C:\WINDOWS\system32> optimize-vhd -Path C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx -Mode full + </literallayout> + A progress bar should be shown while optimizing the VHDX file, + and storage should now be reflected correctly on the Windows + Explorer. + </para></listitem> + </orderedlist> + </para></listitem> + </orderedlist> + <note> + The current implementation of WSLv2 does not have out-of-the-box + access to external devices such as those connected through a + USB port, but it automatically mounts your <filename>C:</filename> + drive on <filename>/mnt/c/</filename> (and others), which + you can use to share deploy artifacts to be later flashed on + hardware through Windows, but your build directory should not + reside inside this mountpoint. + </note> + Once you have WSLv2 set up, everything is in place to + develop just as if you were running on a native Linux machine. + If you are going to use the Extensible SDK container, see the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>Using the Extensible SDK</ulink>" + Chapter in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + If you are going to use the Toaster container, see the + "<ulink url='&YOCTO_DOCS_TOAST_URL;#toaster-manual-setup-and-use'>Setting Up and Using Toaster</ulink>" + section in the Toaster User Manual. + </para> + </section> </section> <section id='locating-yocto-project-source-files'> <title>Locating Yocto Project Source Files</title> <para> - This section shows you how to locate and access the - source files that ship with the Yocto Project. - You establish and use these local files to work on projects. + This section shows you how to locate, fetch and configure the source + files you'll need to work with the Yocto Project. <note><title>Notes</title> <itemizedlist> <listitem><para> @@ -1019,20 +1161,18 @@ . . . - remotes/origin/pyro - remotes/origin/pyro-next - remotes/origin/rocko - remotes/origin/rocko-next - remotes/origin/sumo - remotes/origin/sumo-next remotes/origin/thud remotes/origin/thud-next remotes/origin/warrior + remotes/origin/warrior-next + remotes/origin/zeus + remotes/origin/zeus-next + ... and so on ... </literallayout> </para></listitem> <listitem><para> - <emphasis>Checkout the Branch:</emphasis> - Checkout the development branch in which you want to work. + <emphasis>Check out the Branch:</emphasis> + Check out the development branch in which you want to work. For example, to access the files for the Yocto Project &DISTRO; Release (&DISTRO_NAME;), use the following command: <literallayout class='monospaced'> @@ -1118,7 +1258,7 @@ </literallayout> </para></listitem> <listitem><para> - <emphasis>Checkout the Branch:</emphasis> + <emphasis>Check out the Branch:</emphasis> <literallayout class='monospaced'> $ git checkout tags/&DISTRO_REL_TAG; -b my_yocto_&DISTRO; Switched to a new branch 'my_yocto_&DISTRO;' diff --git a/poky/documentation/dev-manual/dev-manual.xml b/poky/documentation/dev-manual/dev-manual.xml index 04fa1e4f9..6f86454ed 100644..100755 --- a/poky/documentation/dev-manual/dev-manual.xml +++ b/poky/documentation/dev-manual/dev-manual.xml @@ -22,18 +22,17 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> <revhistory> <revision> <revnumber>1.1</revnumber> - <date>6 October 2011</date> + <date>October 2011</date> <revremark>The initial document released with the Yocto Project 1.1 Release.</revremark> </revision> <revision> @@ -57,11 +56,6 @@ <revremark>Released with the Yocto Project 1.5 Release.</revremark> </revision> <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> <revnumber>1.6</revnumber> <date>April 2014</date> <revremark>Released with the Yocto Project 1.6 Release.</revremark> @@ -118,9 +112,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -144,7 +143,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -161,18 +160,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/kernel-dev/kernel-dev-common.xml b/poky/documentation/kernel-dev/kernel-dev-common.xml index 2ea5d3f38..c1c2d6d70 100644 --- a/poky/documentation/kernel-dev/kernel-dev-common.xml +++ b/poky/documentation/kernel-dev/kernel-dev-common.xml @@ -89,8 +89,8 @@ <emphasis>Prepare Your <filename>local.conf</filename> File:</emphasis> By default, the <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> - variable is set to "qemux86", which is fine if you are - building for the QEMU emulator in 32-bit mode. + variable is set to "qemux86-64", which is fine if you are + building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the <filename>MACHINE</filename> variable appropriately in your <filename>conf/local.conf</filename> file found in @@ -104,10 +104,12 @@ <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink> variable to include kernel modules.</para> - <para>This example uses the default "qemux86" for the - <filename>MACHINE</filename> variable but needs to - add the "kernel-modules": + <para>In this example we wish to build for qemux86 so + we must set the <filename>MACHINE</filename> variable + to "qemux86" and also add the "kernel-modules". As described + we do this by appending to <filename>conf/local.conf</filename>: <literallayout class='monospaced'> + MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" </literallayout> </para></listitem> @@ -314,8 +316,8 @@ File:</emphasis> By default, the <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> - variable is set to "qemux86", which is fine if you are - building for the QEMU emulator in 32-bit mode. + variable is set to "qemux86-64", which is fine if you are + building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the <filename>MACHINE</filename> variable appropriately in your <filename>conf/local.conf</filename> file found @@ -329,10 +331,12 @@ <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink> variable to include kernel modules.</para> - <para>This example uses the default "qemux86" for the - <filename>MACHINE</filename> variable but needs to - add the "kernel-modules": + <para>In this example we wish to build for qemux86 so + we must set the <filename>MACHINE</filename> variable + to "qemux86" and also add the "kernel-modules". As described + we do this by appending to <filename>conf/local.conf</filename>: <literallayout class='monospaced'> + MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" </literallayout> </para></listitem> @@ -655,26 +659,22 @@ KMACHINE_genericx86-64 ?= "common-pc-64" KBRANCH_edgerouter = "standard/edgerouter" KBRANCH_beaglebone = "standard/beaglebone" - KBRANCH_mpc8315e-rdb = "standard/fsl-mpc8315e-rdb" SRCREV_machine_genericx86 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" SRCREV_machine_genericx86-64 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" SRCREV_machine_edgerouter ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" SRCREV_machine_beaglebone ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" - SRCREV_machine_mpc8315e-rdb ?= "2d1d010240846d7bff15d1fcc0cb6eb8a22fc78a" COMPATIBLE_MACHINE_genericx86 = "genericx86" COMPATIBLE_MACHINE_genericx86-64 = "genericx86-64" COMPATIBLE_MACHINE_edgerouter = "edgerouter" COMPATIBLE_MACHINE_beaglebone = "beaglebone" - COMPATIBLE_MACHINE_mpc8315e-rdb = "mpc8315e-rdb" LINUX_VERSION_genericx86 = "4.12.7" LINUX_VERSION_genericx86-64 = "4.12.7" LINUX_VERSION_edgerouter = "4.12.10" LINUX_VERSION_beaglebone = "4.12.10" - LINUX_VERSION_mpc8315e-rdb = "4.12.10" </literallayout> This append file contains statements used to support several BSPs that ship with the Yocto Project. @@ -948,12 +948,14 @@ <literallayout class='monospaced'> KBUILD_DEFCONFIG_<replaceable>KMACHINE</replaceable> ?= <replaceable>defconfig_file</replaceable> </literallayout> - Here is an example that appends the - <filename>KBUILD_DEFCONFIG</filename> variable with - "common-pc" and provides the path to the "in-tree" - <filename>defconfig</filename> file: + Here is an example that assigns the + <filename>KBUILD_DEFCONFIG</filename> variable based on + "raspberrypi2" and provides the path to the "in-tree" + <filename>defconfig</filename> file + to be used for a Raspberry Pi 2, + which is based on the Broadcom 2708/2709 chipset: <literallayout class='monospaced'> - KBUILD_DEFCONFIG_common-pc ?= "/home/scottrif/configfiles/my_defconfig_file" + KBUILD_DEFCONFIG_raspberrypi2 ?= "bcm2709_defconfig" </literallayout> </para> diff --git a/poky/documentation/kernel-dev/kernel-dev-concepts-appx.xml b/poky/documentation/kernel-dev/kernel-dev-concepts-appx.xml index 6d675a6d5..62c68527d 100644 --- a/poky/documentation/kernel-dev/kernel-dev-concepts-appx.xml +++ b/poky/documentation/kernel-dev/kernel-dev-concepts-appx.xml @@ -543,7 +543,6 @@ yocto-kernel-cache/features/kgdb/hardware.cfg yocto-kernel-cache/ktypes/base/hardware.cfg yocto-kernel-cache/bsp/mti-malta32/hardware.cfg - yocto-kernel-cache/bsp/fsl-mpc8315e-rdb/hardware.cfg yocto-kernel-cache/bsp/qemu-ppc32/hardware.cfg yocto-kernel-cache/bsp/qemuarma9/hardware.cfg yocto-kernel-cache/bsp/mti-malta64/hardware.cfg diff --git a/poky/documentation/kernel-dev/kernel-dev.xml b/poky/documentation/kernel-dev/kernel-dev.xml index 4c5881b07..998fe4141 100644..100755 --- a/poky/documentation/kernel-dev/kernel-dev.xml +++ b/poky/documentation/kernel-dev/kernel-dev.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -34,7 +33,7 @@ <revision> <revnumber>1.4</revnumber> <date>April 2013</date> - <revremark>Released with the Yocto Project 1.4 Release.</revremark> + <revremark>The initial document released with the Yocto Project 1.4 Release.</revremark> </revision> <revision> <revnumber>1.5</revnumber> @@ -42,11 +41,6 @@ <revremark>Released with the Yocto Project 1.5 Release.</revremark> </revision> <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> <revnumber>1.6</revnumber> <date>April 2014</date> <revremark>Released with the Yocto Project 1.6 Release.</revremark> @@ -103,9 +97,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -127,7 +126,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -144,18 +143,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/mega-manual/mega-manual.xml b/poky/documentation/mega-manual/mega-manual.xml index cd9a3da8f..e730f7259 100644..100755 --- a/poky/documentation/mega-manual/mega-manual.xml +++ b/poky/documentation/mega-manual/mega-manual.xml @@ -33,11 +33,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -45,7 +44,7 @@ <revision> <revnumber>1.8</revnumber> <date>April 2015</date> - <revremark>Released with the Yocto Project 1.8 Release.</revremark> + <revremark>The initial document released with the Yocto Project 1.8 Release.</revremark> </revision> <revision> <revnumber>2.0</revnumber> @@ -89,9 +88,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -113,7 +117,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -130,18 +134,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> diff --git a/poky/documentation/overview-manual/overview-manual-development-environment.xml b/poky/documentation/overview-manual/overview-manual-development-environment.xml index 2f1bd1610..36ebf8a32 100644 --- a/poky/documentation/overview-manual/overview-manual-development-environment.xml +++ b/poky/documentation/overview-manual/overview-manual-development-environment.xml @@ -87,7 +87,7 @@ as its operating system as your development host. When you have a Mac or Windows-based system, you can set it up as the development host by using - <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>, + <ulink url='https://github.com/crops/poky-container'>CROPS</ulink>, which leverages <ulink url='https://www.docker.com/'>Docker Containers</ulink>. Once you take the steps to set up a CROPS machine, you effectively diff --git a/poky/documentation/overview-manual/overview-manual-yp-intro.xml b/poky/documentation/overview-manual/overview-manual-yp-intro.xml index dbf62cc16..1b60a3030 100644 --- a/poky/documentation/overview-manual/overview-manual-yp-intro.xml +++ b/poky/documentation/overview-manual/overview-manual-yp-intro.xml @@ -225,9 +225,9 @@ For information that helps you transition from trying out the Yocto Project to using it for your project, see the - "<ulink url='&YOCTO_HOME_URL;/docs/what-i-wish-id-known/'>What I wish I'd Known</ulink>" + "<ulink url='&YOCTO_DOCS_URL;/what-i-wish-id-known/'>What I wish I'd Known</ulink>" and - "<ulink url='&YOCTO_HOME_URL;/docs/transitioning-to-a-custom-environment/'>Transitioning to a Custom Environment for Systems Development</ulink>" + "<ulink url='&YOCTO_DOCS_URL;/transitioning-to-a-custom-environment/'>Transitioning to a Custom Environment for Systems Development</ulink>" documents on the Yocto Project website. </para></listitem> <listitem><para> @@ -437,7 +437,7 @@ <itemizedlist> <listitem><para id='gs-crops-overview'> <emphasis>CROPS:</emphasis> - <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink> + <ulink url='https://github.com/crops/poky-container/'>CROPS</ulink> is an open source, cross-platform development framework that leverages <ulink url='https://www.docker.com/'>Docker Containers</ulink>. @@ -883,7 +883,7 @@ <listitem><para> <emphasis>CROss PlatformS (CROPS):</emphasis> Typically, you use - <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>, + <ulink url='https://github.com/crops/poky-container/'>CROPS</ulink>, which leverages <ulink url='https://www.docker.com/'>Docker Containers</ulink>, to set up a Build Host that is not running Linux (e.g. @@ -908,6 +908,24 @@ section in the Yocto Project Development Tasks Manual. </para></listitem> <listitem><para> + <emphasis>Windows Subsystem For Linux (WSLv2):</emphasis> + You may use Windows Subsystem For Linux v2 to set up a build + host using Windows 10. + <note> + The Yocto Project is not compatible with WSLv1, it is + compatible but not officially supported nor validated + with WSLv2, if you still decide to use WSL please upgrade + to WSLv2. + </note> + The Windows Subsystem For Linux allows Windows 10 to run a real + Linux kernel inside of a lightweight utility virtual + machine (VM) using virtualization technology.</para> + <para>For information on how to set up a Build Host with + WSLv2, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-to-use-wsl'>Setting Up to Use Windows Subsystem For Linux</ulink>" + section in the Yocto Project Development Tasks Manual. + </para></listitem> + <listitem><para> <emphasis>Toaster:</emphasis> Regardless of what your Build Host is running, you can use Toaster to develop software using the Yocto Project. diff --git a/poky/documentation/overview-manual/overview-manual.xml b/poky/documentation/overview-manual/overview-manual.xml index c7716e460..210d644b3 100644..100755 --- a/poky/documentation/overview-manual/overview-manual.xml +++ b/poky/documentation/overview-manual/overview-manual.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -39,7 +38,7 @@ <revision> <revnumber>2.6</revnumber> <date>November 2018</date> - <revremark>Released with the Yocto Project 2.7 Release.</revremark> + <revremark>Released with the Yocto Project 2.6 Release.</revremark> </revision> <revision> <revnumber>2.7</revnumber> @@ -48,9 +47,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -74,7 +78,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -91,18 +95,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/poky.ent b/poky/documentation/poky.ent index 7af47df72..a54793911 100644..100755 --- a/poky/documentation/poky.ent +++ b/poky/documentation/poky.ent @@ -1,19 +1,21 @@ -<!ENTITY DISTRO "3.0"> -<!ENTITY DISTRO_COMPRESSED "30"> -<!ENTITY DISTRO_NAME_NO_CAP "zeus"> -<!ENTITY DISTRO_NAME "Zeus"> -<!ENTITY DISTRO_NAME_NO_CAP_MINUS_ONE "warrior"> -<!ENTITY DISTRO_NAME_MINUS_ONE "Warrior"> -<!ENTITY YOCTO_DOC_VERSION "3.0"> -<!ENTITY YOCTO_DOC_VERSION_MINUS_ONE "2.7"> -<!ENTITY DISTRO_REL_TAG "yocto-3.0"> -<!ENTITY METAINTELVERSION "9.0"> -<!ENTITY REL_MONTH_YEAR "October 2019"> +<!ENTITY DISTRO "3.1"> +<!ENTITY DISTRO_COMPRESSED "31"> +<!ENTITY DISTRO_NAME_NO_CAP "dunfell"> +<!ENTITY DISTRO_NAME "Dunfell"> +<!ENTITY DISTRO_NAME_NO_CAP_MINUS_ONE "zeus"> +<!ENTITY DISTRO_NAME_MINUS_ONE "Zeus"> +<!ENTITY YOCTO_DOC_VERSION "3.1"> +<!ENTITY YOCTO_DOC_VERSION_MINUS_ONE "3.0.2"> +<!ENTITY DISTRO_REL_TAG "yocto-3.1"> +<!ENTITY METAINTELVERSION "12.0"> +<!ENTITY REL_MONTH_YEAR "April 2020"> <!ENTITY META_INTEL_REL_TAG "&METAINTELVERSION;-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;"> -<!ENTITY POKYVERSION "22.0.0"> -<!ENTITY POKYVERSION_COMPRESSED "2200"> +<!ENTITY POKYVERSION "23.0.0"> +<!ENTITY POKYVERSION_COMPRESSED "2300"> <!ENTITY YOCTO_POKY "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"> -<!ENTITY COPYRIGHT_YEAR "2010-2019"> +<!ENTITY COPYRIGHT_YEAR "2010-2020"> +<!ENTITY ORGNAME "The Yocto Project"> +<!ENTITY ORGEMAIL "docs@lists.yoctoproject.org"> <!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org"> <!ENTITY YOCTO_HOME_URL "http://www.yoctoproject.org"> <!ENTITY YOCTO_LISTS_URL "http://lists.yoctoproject.org"> @@ -58,22 +60,30 @@ <!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> <!ENTITY OE_INIT_FILE "oe-init-build-env"> <!ENTITY UBUNTU_HOST_PACKAGES_ESSENTIAL "gawk wget git-core diffstat unzip texinfo gcc-multilib \ - build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \ + build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ pylint3 xterm"> <!ENTITY FEDORA_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python3 unzip perl patch \ diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ - python3-jinja2 SDL-devel xterm"> + python3-jinja2 SDL-devel xterm rpcgen"> <!ENTITY OPENSUSE_HOST_PACKAGES_ESSENTIAL "python gcc gcc-c++ git chrpath make wget python-xml \ diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ - python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 - $ sudo pip3 install GitPython libSDL-devel xterm"> -<!ENTITY CENTOS_HOST_PACKAGES_ESSENTIAL "-y epel-release + python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen + $ sudo pip3 install GitPython"> +<!ENTITY CENTOS7_HOST_PACKAGES_ESSENTIAL "-y epel-release $ sudo yum makecache - $ sudo yum install gawk make wget tar bzip2 gzip python unzip perl patch \ + $ sudo yum install gawk make wget tar bzip2 gzip python3 unzip perl patch \ diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \ - perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python34-pip xz \ + perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python36-pip xz \ which SDL-devel xterm $ sudo pip3 install GitPython jinja2"> +<!ENTITY CENTOS8_HOST_PACKAGES_ESSENTIAL "-y epel-release + $ sudo dnf config-manager --set-enabled PowerTools + $ sudo dnf makecache + $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ + diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ + socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ + python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ + rpcgen"> diff --git a/poky/documentation/profile-manual/profile-manual-usage.xml b/poky/documentation/profile-manual/profile-manual-usage.xml index 5999b2960..9a4273a0f 100644 --- a/poky/documentation/profile-manual/profile-manual-usage.xml +++ b/poky/documentation/profile-manual/profile-manual-usage.xml @@ -2182,7 +2182,7 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' </literallayout> Once you've done that, you can cd to whatever directory diff --git a/poky/documentation/profile-manual/profile-manual.xml b/poky/documentation/profile-manual/profile-manual.xml index c1f461f43..fa1fa8ac8 100644..100755 --- a/poky/documentation/profile-manual/profile-manual.xml +++ b/poky/documentation/profile-manual/profile-manual.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -34,7 +33,7 @@ <revision> <revnumber>1.4</revnumber> <date>April 2013</date> - <revremark>Released with the Yocto Project 1.4 Release.</revremark> + <revremark>The initial document released with the Yocto Project 1.4 Release.</revremark> </revision> <revision> <revnumber>1.5</revnumber> @@ -42,11 +41,6 @@ <revremark>Released with the Yocto Project 1.5 Release.</revremark> </revision> <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> <revnumber>1.6</revnumber> <date>April 2014</date> <revremark>Released with the Yocto Project 1.6 Release.</revremark> @@ -103,9 +97,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -129,7 +128,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -146,18 +145,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/ref-manual/faq.xml b/poky/documentation/ref-manual/faq.xml index 49ff86261..d94cb32a8 100644 --- a/poky/documentation/ref-manual/faq.xml +++ b/poky/documentation/ref-manual/faq.xml @@ -33,7 +33,7 @@ <para id='faq-not-meeting-requirements'> My development system does not meet the required Git, tar, and Python versions. - In particular, I do not have Python 3.4.0 or greater. + In particular, I do not have Python 3.5.0 or greater. Can I still use the Yocto Project? </para> </question> @@ -43,7 +43,7 @@ system a couple different ways (i.e. building a tarball or downloading a tarball). See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>" section for steps on how to update your build tools. </para> </answer> diff --git a/poky/documentation/ref-manual/migration.xml b/poky/documentation/ref-manual/migration.xml index 8d50ab913..affc8b90a 100644 --- a/poky/documentation/ref-manual/migration.xml +++ b/poky/documentation/ref-manual/migration.xml @@ -680,7 +680,7 @@ <para> For more information on this requirement, see the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>" section. </para> </section> @@ -875,8 +875,7 @@ not work. This change is intended to catch those kinds of situations. Valid <filename>IMAGE_FEATURES</filename> are drawn from - <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> - definitions, + <filename>PACKAGE_GROUP</filename> definitions, <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link> and a new "validitems" varflag on <filename>IMAGE_FEATURES</filename>. @@ -1404,8 +1403,7 @@ <para> The - <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> - variable has been renamed to + <filename>PACKAGE_GROUP</filename> variable has been renamed to <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link> to more accurately reflect its purpose. You can still use <filename>PACKAGE_GROUP</filename> but @@ -1754,7 +1752,7 @@ Git that meets this requirement, you can use the <filename>buildtools-tarball</filename> that does. See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>" section for more information. </para> </section> @@ -2110,7 +2108,7 @@ such as the following: <literallayout class='monospaced'> inherit bluetooth - PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)} + PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}" PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4" PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5" </literallayout> @@ -3215,7 +3213,7 @@ recent version, you can install the buildtools, which will provide it. See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>" section for more information on the buildtools tarball. </para></listitem> <listitem><para> @@ -3624,7 +3622,7 @@ $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64. image types, this part of the kernel image base name as been removed leaving only the following: <literallayout class='monospaced'> - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME} + KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" </literallayout> If you have recipes or classes that use <filename>KERNEL_IMAGE_BASE_NAME</filename> directly, you might @@ -5601,7 +5599,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>. creation time, use <filename>pkg_postinst_ontarget()</filename> or call - <filename>postinst-intercepts defer_to_first_boot</filename> + <filename>postinst_intercept delay_to_first_boot</filename> from <filename>pkg_postinst()</filename>. Any failure of a <filename>pkg_postinst()</filename> script (including <filename>exit 1</filename>) @@ -6192,7 +6190,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>. If you want to explicitly defer a postinstall to first boot on the target rather than at rootfs creation time, use <filename>pkg_postinst_ontarget()</filename> or call - <filename>postinst-intercepts defer_to_first_boot</filename> from + <filename>postinst_intercept delay_to_first_boot</filename> from <filename>pkg_postinst()</filename>. Any failure of a <filename>pkg_postinst()</filename> script (including exit 1) triggers an error during the @@ -7095,6 +7093,207 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>. </section> </section> + +<section id='moving-to-the-yocto-project-3.1-release'> + <title>Moving to the Yocto Project 3.1 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 3.1 Release from the prior release. + </para> + + <section id='migration-3.1-minimum-system-requirements'> + <title>Minimum system requirements</title> + + <para> + The following versions / requirements of build host components have been updated: + <itemizedlist> + <listitem><para>gcc 5.0</para></listitem> + <listitem><para>python 3.5</para></listitem> + <listitem><para>tar 1.28</para></listitem> + <listitem><para><filename>rpcgen</filename> is now required on the host (part of the <filename>libc-dev-bin</filename> package on Ubuntu, Debian and related distributions, and the <filename>glibc</filename> package on RPM-based distributions).</para></listitem> + </itemizedlist> + + Additionally, the <filename>makeinfo</filename> and <filename>pod2man</filename> + tools are <emphasis>no longer</emphasis> required on the host. + </para> + </section> + + <section id='migration-3.1-mpc8315e-rdb-removed'> + <title>mpc8315e-rdb machine removed</title> + + <para> + The MPC8315E-RDB machine is old/obsolete and unobtainable, thus given the maintenance burden + the <filename>mpc8315e-rdb</filename> machine configuration that supported it has been removed + in this release. The removal does leave a gap in official PowerPC reference hardware + support; this may change in future if a suitable machine with accompanying support resources + is found. + </para> + </section> + + <section id='migration-3.1-python-2-removed'> + <title>Python 2 removed</title> + + <para> + Due to the expiration of upstream support in January 2020, support for Python 2 has now been removed; it is recommended that you use Python 3 instead. If absolutely needed there is a meta-python2 community layer containing Python 2, related classes and various Python 2-based modules, however it should not be considered as supported. + </para> + </section> + + <section id='migration-3.1-reproducible-builds'> + <title>Reproducible builds now enabled by default</title> + + <para> + In order to avoid unnecessary differences in output files (aiding binary reproducibility), the Poky distribution configuration (<filename><link linkend='var-DISTRO'>DISTRO</link> = "poky"</filename>) now inherits the <filename>reproducible_build</filename> class by default. + </para> + </section> + + <section id='migration-3.1-ptest-feature-impact'> + <title>Impact of ptest feature is now more significant</title> + + <para> + The Poky distribution configuration (<filename><link linkend='var-DISTRO'>DISTRO</link> = "poky"</filename>) enables ptests by default to enable runtime testing of various components. In this release, a dependency needed to be added that has resulted in a significant increase in the number of components that will be built just when building a simple image such as core-image-minimal. If you do not need runtime tests enabled for core components, then it is recommended that you remove "ptest" from <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> to save a significant amount of build time e.g. by adding the following in your configuration: + + <literallayout class='monospaced'> + DISTRO_FEATURES_remove = "ptest" + </literallayout> + </para> + </section> + + <section id='migration-3.1-removed-recipes'> + <title>Removed recipes</title> + + <para> + The following recipes have been removed: + + <itemizedlist> + <listitem><para><filename>chkconfig</filename>: obsolete</para></listitem> + <listitem><para><filename>console-tools</filename>: obsolete</para></listitem> + <listitem><para><filename>enchant</filename>: replaced by <filename>enchant2</filename></para></listitem> + <listitem><para><filename>foomatic-filters</filename>: obsolete</para></listitem> + <listitem><para><filename>libidn</filename>: no longer needed, moved to meta-oe</para></listitem> + <listitem><para><filename>libmodulemd</filename>: replaced by <filename>libmodulemd-v1</filename></para></listitem> + <listitem><para><filename>linux-yocto</filename>: drop 4.19, 5.2 version recipes (5.4 now provided)</para></listitem> + <listitem><para><filename>nspr</filename>: no longer needed, moved to meta-oe</para></listitem> + <listitem><para><filename>nss</filename>: no longer needed, moved to meta-oe</para></listitem> + <listitem><para><filename>python</filename>: Python 2 removed (Python 3 preferred)</para></listitem> + <listitem><para><filename>python-setuptools</filename>: Python 2 version removed (python3-setuptools preferred)</para></listitem> + <listitem><para><filename>sysprof</filename>: no longer needed, moved to meta-oe</para></listitem> + <listitem><para><filename>texi2html</filename>: obsolete</para></listitem> + <listitem><para><filename>u-boot-fw-utils</filename>: functionally replaced by <filename>libubootenv</filename></para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-3.1-features-check'> + <title>features_check class replaces distro_features_check</title> + + <para> + The <filename>distro_features_check</filename> class has had its functionality expanded, now supporting <filename>ANY_OF_MACHINE_FEATURES</filename>, <filename>REQUIRED_MACHINE_FEATURES</filename>, <filename>CONFLICT_MACHINE_FEATURES</filename>, <filename>ANY_OF_COMBINED_FEATURES</filename>, <filename>REQUIRED_COMBINED_FEATURES</filename>, <filename>CONFLICT_COMBINED_FEATURES</filename>. As a result the class has now been renamed to <filename>features_check</filename>; the <filename>distro_features_check</filename> class still exists but generates a warning and redirects to the new class. In preparation for a future removal of the old class it is recommended that you update recipes currently inheriting <filename>distro_features_check</filename> to inherit <filename>features_check</filename> instead. + </para> + </section> + + <section id='migration-3.1-removed-classes'> + <title>Removed classes</title> + + <para> + The following classes have been removed: + + <itemizedlist> + <listitem><para><filename>distutils-base</filename>: moved to meta-python2</para></listitem> + <listitem><para><filename>distutils</filename>: moved to meta-python2</para></listitem> + <listitem><para><filename>libc-common</filename>: merged into the glibc recipe as nothing else used it.</para></listitem> + <listitem><para><filename>python-dir</filename>: moved to meta-python2</para></listitem> + <listitem><para><filename>pythonnative</filename>: moved to meta-python2</para></listitem> + <listitem><para><filename>setuptools</filename>: moved to meta-python2</para></listitem> + <listitem><para><filename>tinderclient</filename>: dropped as it was obsolete.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-3.1-src-uri-checksums'> + <title>SRC_URI checksum behaviour</title> + + <para> + Previously, recipes by tradition included both SHA256 and MD5 checksums for remotely fetched files in <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, even though only one is actually mandated. However, the MD5 checksum does not add much given its inherent weakness; thus when a checksum fails only the SHA256 sum will now be printed. The md5sum will still be verified if it is specified. + </para> + </section> + + + <section id='migration-3.1-npm'> + <title>npm fetcher changes</title> + + <para> + The npm fetcher has been completely reworked in this release. The npm fetcher now only fetches the package source itself and no longer the dependencies; there is now also an npmsw fetcher which explicitly fetches the shrinkwrap file and the dependencies. This removes the slightly awkward <filename>NPM_LOCKDOWN</filename> and <filename>NPM_SHRINKWRAP</filename> variables which pointed to local files; the lockdown file is no longer needed at all. Additionally, the package name in <filename>npm://</filename> entries in <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> is now specified using a <filename>package</filename> parameter instead of the earlier <filename>name</filename> which overlapped with the generic <filename>name</filename> parameter. All recipes using the npm fetcher will need to be changed as a result. + </para> + <para> + An example of the new scheme: + <literallayout class='monospaced'> +SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \ + npmsw://${THISDIR}/npm-shrinkwrap.json" + </literallayout> + Another example where the sources are fetched from git rather than an npm repository: + <literallayout class='monospaced'> +SRC_URI = "git://github.com/foo/bar.git;protocol=https \ + npmsw://${THISDIR}/npm-shrinkwrap.json" + </literallayout> + </para> + <para> + devtool and recipetool have also been updated to match with the npm fetcher changes. Other than producing working and more complete recipes for npm sources, there is also a minor change to the command line for devtool: the <filename>--fetch-dev</filename> option has been renamed to <filename>--npm-dev</filename> as it is npm-specific. + </para> + </section> + + + <section id='migration-3.1-packaging-changes'> + <title>Packaging changes</title> + + <para> + <itemizedlist> + <listitem><para><filename>intltool</filename> has been removed from <filename>packagegroup-core-sdk</filename> as it is rarely needed to build modern software - gettext can do most of the things it used to be needed for. <filename>intltool</filename> has also been removed from <filename>packagegroup-core-self-hosted</filename> as it is not needed to for standard builds.</para></listitem> + <listitem><para>git: <filename>git-am</filename>, <filename>git-difftool</filename>, <filename>git-submodule</filename>, and <filename>git-request-pull</filename> are no longer perl-based, so are now installed with the main <filename>git</filename> package instead of within <filename>git-perltools</filename>.</para></listitem> + <listitem><para>The <filename>ldconfig</filename> binary built as part of glibc has now been moved to its own <filename>ldconfig</filename> package (note no <filename>glibc-</filename> prefix). This package is in the <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> of the main <filename>glibc</filename> package if <filename>ldconfig</filename> is present in <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.</para></listitem> + <listitem><para><filename>libevent</filename> now splits each shared library into its own package (as Debian does). Since these are shared libraries and will be pulled in through the normal shared library dependency handling, there should be no impact to existing configurations other than less unnecessary libraries being installed in some cases.</para></listitem> + <listitem><para>linux-firmware now has a new package for <filename>bcm4366c</filename> and includes available NVRAM config files into the <filename>bcm43340</filename>, <filename>bcm43362</filename>, <filename>bcm43430</filename> and <filename>bcm4356-pcie</filename> packages.</para></listitem> + <listitem><para><filename>harfbuzz</filename> now splits the new <filename>libharfbuzz-subset.so</filename> library into its own package to reduce the main package size in cases where <filename>libharfbuzz-subset.so</filename> is not needed.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-3.1-package-qa-warnings'> + <title>Additional warnings</title> + + <para> + Warnings will now be shown at <filename>do_package_qa</filename> time in the following circumstances: + + <itemizedlist> + <listitem><para>A recipe installs <filename>.desktop</filename> files containing <filename>MimeType</filename> keys but does not inherit the new <filename>mime-xdg</filename> class</para></listitem> + <listitem><para>A recipe installs <filename>.xml</filename> files into <filename>${datadir}/mime/packages</filename> but does not inherit the <filename>mime</filename> class</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-3.1-x86-live-wic'> + <title><filename>wic</filename> image type now used instead of <filename>live</filename> by default for x86</title> + + <para> + <filename>conf/machine/include/x86-base.inc</filename> (inherited by most x86 machine configurations) now specifies <filename>wic</filename> instead of <filename>live</filename> by default in <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. The <filename>live</filename> image type will likely be removed in a future release so it is recommended that you use <filename>wic</filename> instead. + </para> + </section> + + <section id='migration-3.1-misc'> + <title>Miscellaneous changes</title> + + <para> + <itemizedlist> + <listitem><para>The undocumented <filename>SRC_DISTRIBUTE_LICENSES</filename> variable has now been removed in favour of a new <filename>AVAILABLE_LICENSES</filename> variable which is dynamically set based upon license files found in <filename>${COMMON_LICENSE_DIR}</filename> and <filename>${LICENSE_PATH}</filename>.</para></listitem> + <listitem><para>The tune definition for big-endian microblaze machines is now <filename>microblaze</filename> instead of <filename>microblazeeb</filename>.</para></listitem> + <listitem><para><filename>newlib</filename> no longer has built-in syscalls. <filename>libgloss</filename> should then provide the syscalls, <filename>crt0.o</filename> and other functions that are no longer part of <filename>newlib</filename> itself. If you are using <filename>TCLIBC = "newlib"</filename> this now means that you must link applications with both <filename>newlib</filename> and <filename>libgloss</filename>, whereas before <filename>newlib</filename> would run in many configurations by itself.</para></listitem> + </itemizedlist> + </para> + </section> + +</section> + + </chapter> <!-- vim: expandtab tw=80 ts=4 diff --git a/poky/documentation/ref-manual/ref-classes.xml b/poky/documentation/ref-manual/ref-classes.xml index f9bbddd72..f8920d8c1 100644 --- a/poky/documentation/ref-manual/ref-classes.xml +++ b/poky/documentation/ref-manual/ref-classes.xml @@ -1742,6 +1742,12 @@ This check was removed for YP 2.3 release </note> </para></listitem> --> + <listitem><para><emphasis><filename>unlisted-pkg-lics:</filename></emphasis> + Checks that all declared licenses applying for a package are also + declared on the recipe level (i.e. any license in + <filename>LICENSE_*</filename> should appear in + <link linkend='var-LICENSE'><filename>LICENSE</filename></link>). + </para></listitem> <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis> Checks for dynamic library load paths (rpaths) in the binaries that by default on a standard system are searched by the linker (e.g. diff --git a/poky/documentation/ref-manual/ref-features.xml b/poky/documentation/ref-manual/ref-features.xml index 44ba67cf5..294b297c2 100644 --- a/poky/documentation/ref-manual/ref-features.xml +++ b/poky/documentation/ref-manual/ref-features.xml @@ -210,6 +210,12 @@ <listitem><para><emphasis>usbhost:</emphasis> Include USB Host support (allows to connect external keyboard, mouse, storage, network etc).</para></listitem> + <listitem><para><emphasis>usrmerge:</emphasis> Merges the + <filename>/bin</filename>, <filename>/sbin</filename>, + <filename>/lib</filename>, and <filename>/lib64</filename> + directories into their respective counterparts in the + <filename>/usr</filename> directory to provide better package + and application compatibility.</para></listitem> <listitem><para><emphasis>wayland:</emphasis> Include the Wayland display server protocol and the library that supports it.</para></listitem> diff --git a/poky/documentation/ref-manual/ref-manual.xml b/poky/documentation/ref-manual/ref-manual.xml index b442f709a..9a914f19c 100644..100755 --- a/poky/documentation/ref-manual/ref-manual.xml +++ b/poky/documentation/ref-manual/ref-manual.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -34,22 +33,17 @@ <revhistory> <revision> <revnumber>4.0+git</revnumber> - <date>24 November 2010</date> - <revremark>Released with the Yocto Project 0.9 Release</revremark> + <date>November 2010</date> + <revremark>The initial document released with the Yocto Project 0.9 Release</revremark> </revision> <revision> <revnumber>1.0</revnumber> - <date>6 April 2011</date> + <date>April 2011</date> <revremark>Released with the Yocto Project 1.0 Release.</revremark> </revision> <revision> - <revnumber>1.0.1</revnumber> - <date>23 May 2011</date> - <revremark>Released with the Yocto Project 1.0.1 Release.</revremark> - </revision> - <revision> <revnumber>1.1</revnumber> - <date>6 October 2011</date> + <date>October 2011</date> <revremark>Released with the Yocto Project 1.1 Release.</revremark> </revision> <revision> @@ -73,11 +67,6 @@ <revremark>Released with the Yocto Project 1.5 Release.</revremark> </revision> <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> <revnumber>1.6</revnumber> <date>April 2014</date> <revremark>Released with the Yocto Project 1.6 Release.</revremark> @@ -134,9 +123,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -158,7 +152,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -175,18 +169,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/ref-manual/ref-qa-checks.xml b/poky/documentation/ref-manual/ref-qa-checks.xml index 515106ae6..424a19c59 100644 --- a/poky/documentation/ref-manual/ref-qa-checks.xml +++ b/poky/documentation/ref-manual/ref-qa-checks.xml @@ -1170,6 +1170,31 @@ can be found then it should be implemented. I can't find one at the moment. </listitem> </itemizedlist> </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-unlisted-pkg-lics'> + <code> + LICENSE_<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics] + </code> + </para> + + <para> + The <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + of the recipe should be a superset of all the licenses of + all packages produced by this recipe. + In other words, any license in <filename>LICENSE_*</filename> + should also appear in + <link linkend='var-LICENSE'><filename>LICENSE</filename></link>. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> </section> <section id='configuring-and-disabling-qa-checks'> diff --git a/poky/documentation/ref-manual/ref-structure.xml b/poky/documentation/ref-manual/ref-structure.xml index 8e0c9f5b6..27f17dd91 100644 --- a/poky/documentation/ref-manual/ref-structure.xml +++ b/poky/documentation/ref-manual/ref-structure.xml @@ -8,11 +8,11 @@ <para> The <link linkend='source-directory'>Source Directory</link> - consists of several components. - Understanding them and knowing where they are located is key to using the - Yocto Project well. + consists of numerous files, directories and subdirectories; + understanding their locations and contents is key to using the + Yocto Project effectively. This chapter describes the Source Directory and gives information about - the various files and directories. + those files and directories. </para> <para> @@ -22,12 +22,12 @@ section in the Yocto Project Development Tasks Manual. </para> -<note> - The OpenEmbedded build system does not support file or directory names that - contain spaces. - Be sure that the Source Directory you use does not contain these types - of names. -</note> + <note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + Be sure that the Source Directory you use does not contain these types + of names. + </note> <section id='structure-core'> <title>Top-Level Core Components</title> @@ -48,18 +48,18 @@ <link linkend='metadata'>Metadata</link> interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. - Failures are usually from the Metadata and not from BitBake itself. - Consequently, most users do not need to worry about BitBake. + Failures are usually caused by errors in your Metadata and not from BitBake itself; + consequently, most users do not need to worry about BitBake. </para> <para> When you run the <filename>bitbake</filename> command, the - main BitBake executable, which resides in the - <filename>bitbake/bin/</filename> directory, starts. + main BitBake executable (which resides in the + <filename>bitbake/bin/</filename> directory) starts. Sourcing the environment setup script (i.e. <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>) - places the <filename>scripts</filename> and - <filename>bitbake/bin</filename> directories (in that order) into + places the <filename>scripts/</filename> and + <filename>bitbake/bin/</filename> directories (in that order) into the shell's <filename>PATH</filename> environment variable. </para> @@ -91,7 +91,7 @@ by providing a directory name when you <filename>source</filename> the setup script. For information on separating output from your local - Source Directory files, see the + Source Directory files (commonly described as an "out of tree" build), see the "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" section. </para> @@ -104,8 +104,8 @@ This directory holds the source for the Yocto Project documentation as well as templates and tools that allow you to generate PDF and HTML versions of the manuals. - Each manual is contained in a sub-folder. - For example, the files for this manual reside in + Each manual is contained in its own sub-folder; + for example, the files for this reference manual reside in the <filename>ref-manual/</filename> directory. </para> </section> @@ -114,9 +114,9 @@ <title><filename>meta/</filename></title> <para> - This directory contains the OpenEmbedded-Core metadata. + This directory contains the minimal, underlying OpenEmbedded-Core metadata. The directory holds recipes, common classes, and machine - configuration for emulated targets (<filename>qemux86</filename>, + configuration for strictly emulated targets (<filename>qemux86</filename>, <filename>qemuarm</filename>, and so forth.) </para> </section> @@ -125,8 +125,8 @@ <title><filename>meta-poky/</filename></title> <para> - This directory contains the configuration for the Poky - reference distribution. + Designed above the <filename>meta/</filename> content, this directory + adds just enough metadata to define the Poky reference distribution. </para> </section> @@ -148,9 +148,6 @@ This directory adds additional recipes and append files used by the OpenEmbedded selftests to verify the behavior of the build system. - </para> - - <para> You do not have to add this layer to your <filename>bblayers.conf</filename> file unless you want to run the selftests. @@ -172,7 +169,7 @@ This directory contains various integration scripts that implement extra functionality in the Yocto Project environment (e.g. QEMU scripts). The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> - script appends this directory to the shell's + script prepends this directory to the shell's <filename>PATH</filename> environment variable. </para> @@ -202,7 +199,8 @@ up, a <link linkend='build-directory'>Build Directory</link> is created, your working directory becomes the Build Directory, - and you are presented with a list of common BitBake targets. + and you are presented with some simple suggestions as to what to do + next, including a list of some possible targets to build. Here is an example: <literallayout class='monospaced'> $ source oe-init-build-env @@ -217,14 +215,14 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' </literallayout> - The script gets its default list of common targets from the - <filename>conf-notes.txt</filename> file, which is found in the + The default output of the <filename>oe-init-build-env</filename> script + is from the <filename>conf-notes.txt</filename> file, which is found in the <filename>meta-poky</filename> directory within the <link linkend='source-directory'>Source Directory</link>. - Should you have custom distributions, it is very easy to modify - this configuration file to include your targets for your + If you design a custom distribution, you can include your own version + of this configuration file to mention the targets defined by your distribution. See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" @@ -234,20 +232,20 @@ <para> By default, running this script without a Build Directory - argument creates the <filename>build</filename> directory + argument creates the <filename>build/</filename> directory in your current working directory. If you provide a Build Directory argument when you <filename>source</filename> the script, you direct the OpenEmbedded build system to create a Build Directory of your choice. For example, the following command creates a Build Directory named - <filename>mybuilds</filename> that is outside of the + <filename>mybuilds/</filename> that is outside of the <link linkend='source-directory'>Source Directory</link>: <literallayout class='monospaced'> $ source &OE_INIT_FILE; ~/mybuilds </literallayout> The OpenEmbedded build system uses the template configuration files, which are found by default in the - <filename>meta-poky/conf</filename> directory in the + <filename>meta-poky/conf/</filename> directory in the Source Directory. See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" @@ -280,28 +278,26 @@ <para> The OpenEmbedded build system creates the <link linkend='build-directory'>Build Directory</link> - when you run the build environment setup scripts (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para> - - <para> + when you run the build environment setup script + <link +linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>. If you do not give the Build Directory a specific name when you run - a setup script, the name defaults to <filename>build</filename>. + the setup script, the name defaults to <filename>build/</filename>. </para> <para> - The - <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable - points to the Build Directory. + For subsequent parsing and processing, the name of the Build + directory is available via the + <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable. </para> <section id='structure-build-buildhistory'> - <title><filename>build/buildhistory</filename></title> + <title><filename>build/buildhistory/</filename></title> <para> The OpenEmbedded build system creates this directory when you - enable the build history feature. - The directory tracks build information into image, packages, and + enable build history via the <filename>buildhistory</filename> class file. + The directory organizes build information into image, packages, and SDK subdirectories. For information on the build history feature, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" @@ -320,14 +316,14 @@ Any variable set here overrides any variable set elsewhere within the environment unless that variable is hard-coded within a file (e.g. by using '=' instead of '?='). - Some variables are hard-coded for various reasons but these + Some variables are hard-coded for various reasons but such variables are relatively rare. </para> <para> - Edit this file to set the - <filename><link linkend='var-MACHINE'>MACHINE</link></filename> - for which you want to build, which package types you wish to use + At a minimum, you would normally edit this file to select the target + <filename><link linkend='var-MACHINE'>MACHINE</link></filename>, + which package types you wish to use (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), and the location from which you want to access downloaded files (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>). @@ -338,16 +334,16 @@ start the build, the OpenEmbedded build system creates it from <filename>local.conf.sample</filename> when you <filename>source</filename> the top-level build environment - setup script (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). + setup script + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>. </para> <para> The source <filename>local.conf.sample</filename> file used depends on the <filename>$TEMPLATECONF</filename> script variable, - which defaults to <filename>meta-poky/conf</filename> + which defaults to <filename>meta-poky/conf/</filename> when you are building from the Yocto Project development - environment and defaults to <filename>meta/conf</filename> when + environment, and to <filename>meta/conf/</filename> when you are building from the OpenEmbedded-Core environment. Because the script variable points to the source of the <filename>local.conf.sample</filename> file, this implies that @@ -395,11 +391,12 @@ </para> <para> - The source <filename>bblayers.conf.sample</filename> file used + As with the <filename>local.conf</filename> file, + the source <filename>bblayers.conf.sample</filename> file used depends on the <filename>$TEMPLATECONF</filename> script variable, - which defaults to <filename>meta-poky/conf</filename> + which defaults to <filename>meta-poky/conf/</filename> when you are building from the Yocto Project development - environment and defaults to <filename>meta/conf</filename> when + environment, and to <filename>meta/conf/</filename> when you are building from the OpenEmbedded-Core environment. Because the script variable points to the source of the <filename>bblayers.conf.sample</filename> file, this implies that @@ -418,13 +415,13 @@ <link linkend='source-directory'>Source Directory</link>. You can find the Yocto Project version of the <filename>bblayers.conf.sample</filename> file in the - <filename>meta-poky/conf</filename> directory. + <filename>meta-poky/conf/</filename> directory. </note> </para> </section> <section id='structure-build-conf-sanity_info'> - <title><filename>build/conf/sanity_info</filename></title> + <title><filename>build/cache/sanity_info</filename></title> <para> This file indicates the state of the sanity checks and is created @@ -572,8 +569,11 @@ <title><filename>build/tmp/deploy/images/</filename></title> <para> - This directory receives complete filesystem images. - If you want to flash the resulting image from a build onto a device, look here for the image. + This directory is populated with the basic output objects of the + build (think of them as the "generated artifacts" of the build process), + including things like the boot loader image, kernel, root filesystem and more. + If you want to flash the resulting image from a build onto a device, + look here for the necessary components. </para> <para> @@ -604,7 +604,7 @@ <para> The OpenEmbedded build system creates this directory to hold - toolchain installer scripts, which when executed, install the + toolchain installer scripts which, when executed, install the sysroot that matches your target hardware. You can find out more about these installers in the "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" @@ -1038,7 +1038,7 @@ <title><filename>meta/recipes-graphics/</filename></title> <para> - This directory contains X and other graphically related system libraries + This directory contains X and other graphically related system libraries. </para> </section> diff --git a/poky/documentation/ref-manual/ref-system-requirements.xml b/poky/documentation/ref-manual/ref-system-requirements.xml index 9c2198a76..7a11ec2cf 100644 --- a/poky/documentation/ref-manual/ref-system-requirements.xml +++ b/poky/documentation/ref-manual/ref-system-requirements.xml @@ -8,12 +8,12 @@ <para> Welcome to the Yocto Project Reference Manual! This manual provides reference information for the current release - of the Yocto Project. - The manual is best used after you have an understanding + of the Yocto Project, and + is most effectively used after you have an understanding of the basics of the Yocto Project. The manual is neither meant to be read as a starting point to the - Yocto Project nor read from start to finish. - Use this manual to find variable definitions, class + Yocto Project, nor read from start to finish. + Rather, use this manual to find variable definitions, class descriptions, and so forth as needed during the course of using the Yocto Project. </para> @@ -66,12 +66,15 @@ below. </para></listitem> <listitem><para> - The Yocto Project is not compatible with the - <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux</ulink> - (WSL). - You cannot use a - <link linkend='hardware-build-system-term'>build host</link> - that is running WSL. + You may use Windows Subsystem For Linux v2 to set up a build + host using Windows 10, but validation is not performed + against build hosts using WSLv2. + <note> + The Yocto Project is not compatible with WSLv1, it is + compatible but not officially supported nor validated + with WSLv2, if you still decide to use WSL please upgrade + to WSLv2. + </note> </para></listitem> <listitem><para> If you encounter problems, please go to @@ -117,7 +120,7 @@ <para> The list of packages you need on the host development system can be large when covering all build scenarios using the Yocto Project. - This section provides required packages according to + This section describes required packages according to Linux distribution and function. </para> @@ -127,19 +130,29 @@ <para> The following list shows the required packages by function given a supported Ubuntu or Debian Linux distribution: - <note> - If your build system has the - <filename>oss4-dev</filename> package installed, you - might experience QEMU build failures due to the package - installing its own custom - <filename>/usr/include/linux/soundcard.h</filename> on - the Debian system. - If you run into this situation, either of the following - solutions exist: - <literallayout class='monospaced'> + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + If your build system has the + <filename>oss4-dev</filename> package installed, you + might experience QEMU build failures due to the package + installing its own custom + <filename>/usr/include/linux/soundcard.h</filename> on + the Debian system. + If you run into this situation, either of the following + solutions exist: + <literallayout class='monospaced'> $ sudo apt-get build-dep qemu $ sudo apt-get remove oss4-dev - </literallayout> + </literallayout> + </para></listitem> + <listitem><para> + For Debian-8, <filename>python3-git</filename> and <filename>pylint3</filename> are no longer available via <filename>apt-get</filename>. + <literallayout class='monospaced'> + $ sudo pip3 install GitPython pylint==1.9.5 + </literallayout> + </para></listitem> + </itemizedlist> </note> <itemizedlist> <listitem><para><emphasis>Essentials:</emphasis> @@ -205,18 +218,18 @@ </para> </section> - <section id='centos-packages'> - <title>CentOS Packages</title> + <section id='centos-7-packages'> + <title>CentOS-7 Packages</title> <para> The following list shows the required packages by function - given a supported CentOS Linux distribution: + given a supported CentOS-7 Linux distribution: <itemizedlist> <listitem><para><emphasis>Essentials:</emphasis> Packages needed to build an image for a headless system: <literallayout class='monospaced'> - $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; + $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; </literallayout> <note><title>Notes</title> <itemizedlist> @@ -229,29 +242,81 @@ Linux by default. You need to install these packages separately. - </para></listitem> + </para></listitem> <listitem><para> The <filename>makecache</filename> command consumes additional Metadata from <filename>epel-release</filename>. - </para></listitem> + </para></listitem> </itemizedlist> </note> - </para></listitem> + </para></listitem> <listitem><para><emphasis>Documentation:</emphasis> Packages needed if you are going to build out the Yocto Project documentation manuals: <literallayout class='monospaced'> $ sudo yum install docbook-style-dsssl docbook-style-xsl \ docbook-dtds docbook-utils fop libxslt dblatex xmlto - </literallayout></para></listitem> + </literallayout> + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='centos-8-packages'> + <title>CentOS-8 Packages</title> + + <para> + The following list shows the required packages by function + given a supported CentOS-8 Linux distribution: + <itemizedlist> + <listitem><para><emphasis>Essentials:</emphasis> + Packages needed to build an image for a headless + system: + <literallayout class='monospaced'> + $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; + </literallayout> + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + Extra Packages for Enterprise Linux + (i.e. <filename>epel-release</filename>) + is a collection of packages from Fedora + built on RHEL/CentOS for easy installation + of packages not included in enterprise + Linux by default. + You need to install these packages + separately. + </para></listitem> + <listitem><para> + The <filename>PowerTools</filename> repo + provides additional packages such as + <filename>rpcgen</filename> and + <filename>texinfo</filename>. + </para></listitem> + <listitem><para> + The <filename>makecache</filename> command + consumes additional Metadata from + <filename>epel-release</filename>. + </para></listitem> + </itemizedlist> + </note> + </para></listitem> + <listitem><para><emphasis>Documentation:</emphasis> + Packages needed if you are going to build out the + Yocto Project documentation manuals: + <literallayout class='monospaced'> + $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ + docbook-dtds docbook-utils fop libxslt dblatex xmlto + </literallayout> + </para></listitem> </itemizedlist> </para> </section> </section> - <section id='required-git-tar-and-python-versions'> - <title>Required Git, tar, and Python Versions</title> + <section id='required-git-tar-python-and-gcc-versions'> + <title>Required Git, tar, Python and gcc Versions</title> <para> In order to use the build system, your host development system @@ -259,8 +324,8 @@ Python: <itemizedlist> <listitem><para>Git 1.8.3.1 or greater</para></listitem> - <listitem><para>tar 1.27 or greater</para></listitem> - <listitem><para>Python 3.4.0 or greater</para></listitem> + <listitem><para>tar 1.28 or greater</para></listitem> + <listitem><para>Python 3.5.0 or greater</para></listitem> </itemizedlist> </para> @@ -272,6 +337,89 @@ tarball or use BitBake to build the tarball. </para> + <para> + In addition, your host development system must meet the following + version requirement for gcc: + <itemizedlist> + <listitem><para>gcc 5.0 or greater</para></listitem> + </itemizedlist> + </para> + + <para> + If your host development system does not meet this requirement, + you can resolve this by installing a <filename>buildtools-extended</filename> + tarball that contains additional tools, the equivalent of <filename>buildtools-essential</filename>. + </para> + <section id='installing-a-pre-built-buildtools-tarball-with-install-buildtools-script'> + <title>Installing a Pre-Built <filename>buildtools</filename> Tarball with <filename>install-buildtools</filename> script</title> + + <para> + The <filename>install-buildtools</filename> script is the easiest + of the three methods by which you can get these tools. It downloads + a pre-built buildtools installer and automatically installs the tools + for you: + <orderedlist> + <listitem><para> + Execute the <filename>install-buildtools</filename> script. + Here is an example: + <literallayout class='monospaced'> + $ cd poky + $ scripts/install-buildtools --without-extended-buildtools \ + --base-url &YOCTO_DL_URL;/releases/yocto \ + --release yocto-&DISTRO; \ + --installer-version &DISTRO; + </literallayout> + <para> + During execution, the buildtools tarball will be downloaded, + the checksum of the download will be verified, the installer + will be run for you, and some basic checks will be run to + to make sure the installation is functional. + </para> + <para> + To avoid the need of <filename>sudo</filename> privileges, + the <filename>install-buildtools</filename> script will + by default tell the installer to install in: + <literallayout class='monospaced'> + <replaceable>/path/to/</replaceable>poky/buildtools + </literallayout> + </para> + <para> + If your host development system needs the additional tools + provided in the <filename>buildtools-extended</filename> + tarball, you can instead execute the + <filename>install-buildtools</filename> script with the + default parameters: + <literallayout class='monospaced'> + $ cd poky + $ scripts/install-buildtools + </literallayout> + </para> + </para></listitem> + <listitem><para> + Source the tools environment setup script by using a + command like the following: + <literallayout class='monospaced'> + $ source <replaceable>/path/to/</replaceable>poky/buildtools/environment-setup-x86_64-pokysdk-linux + </literallayout> + Of course, you need to supply your installation directory and be + sure to use the right file (i.e. i586 or x86_64). + </para> + <para> + After you have sourced the setup script, + the tools are added to <filename>PATH</filename> + and any other environment variables required to run the + tools are initialized. + The results are working versions versions of Git, tar, + Python and <filename>chrpath</filename>. And in the case of + the <filename>buildtools-extended</filename> tarball, additional + working versions of tools including <filename>gcc</filename>, + <filename>make</filename> and the other tools included in + <filename>packagegroup-core-buildessential</filename>. + </para></listitem> + </orderedlist> + </para> + </section> + <section id='downloading-a-pre-built-buildtools-tarball'> <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title> @@ -281,14 +429,18 @@ <orderedlist> <listitem><para> Locate and download the <filename>*.sh</filename> at - <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>. + <ulink url='&YOCTO_RELEASE_DL_URL;/buildtools/'></ulink>. </para></listitem> <listitem><para> Execute the installation script. - Here is an example: + Here is an example for the traditional installer: <literallayout class='monospaced'> $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh </literallayout> + Here is an example for the extended installer: + <literallayout class='monospaced'> + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh + </literallayout> During execution, a prompt appears that allows you to choose the installation directory. For example, you could choose the following: @@ -311,7 +463,11 @@ and any other environment variables required to run the tools are initialized. The results are working versions versions of Git, tar, - Python and <filename>chrpath</filename>. + Python and <filename>chrpath</filename>. And in the case of + the <filename>buildtools-extended</filename> tarball, additional + working versions of tools including <filename>gcc</filename>, + <filename>make</filename> and the other tools included in + <filename>packagegroup-core-buildessential</filename>. </para></listitem> </orderedlist> </para> @@ -327,7 +483,7 @@ <filename>.sh</filename> file and then take steps to transfer and run it on a machine that does not meet the minimal Git, tar, and Python - requirements. + (or gcc) requirements. </para> <para> @@ -345,6 +501,10 @@ <literallayout class='monospaced'> $ bitbake buildtools-tarball </literallayout> + or run the BitBake command to build the extended tarball: + <literallayout class='monospaced'> + $ bitbake buildtools-extended-tarball + </literallayout> <note> The <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> @@ -358,21 +518,25 @@ subdirectory of the <link linkend='build-directory'>Build Directory</link>. The installer file has the string "buildtools" - in the name. + (or "buildtools-extended") in the name. </para></listitem> <listitem><para> Transfer the <filename>.sh</filename> file from the build host to the machine that does not meet the - Git, tar, or Python requirements. + Git, tar, or Python (or gcc) requirements. </para></listitem> <listitem><para> On the machine that does not meet the requirements, run the <filename>.sh</filename> file to install the tools. - Here is an example: + Here is an example for the traditional installer: <literallayout class='monospaced'> $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh </literallayout> + Here is an example for the extended installer: + <literallayout class='monospaced'> + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh + </literallayout> During execution, a prompt appears that allows you to choose the installation directory. For example, you could choose the following: @@ -384,10 +548,10 @@ Source the tools environment setup script by using a command like the following: <literallayout class='monospaced'> - $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux + $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-x86_64-poky-linux </literallayout> Of course, you need to supply your installation directory and be - sure to use the right file (i.e. i585 or x86-64). + sure to use the right file (i.e. i586 or x86_64). </para> <para> After you have sourced the setup script, @@ -395,7 +559,11 @@ and any other environment variables required to run the tools are initialized. The results are working versions versions of Git, tar, - Python and <filename>chrpath</filename>. + Python and <filename>chrpath</filename>. And in the case of + the <filename>buildtools-extended</filename> tarball, additional + working versions of tools including <filename>gcc</filename>, + <filename>make</filename> and the other tools included in + <filename>packagegroup-core-buildessential</filename>. </para></listitem> </orderedlist> </para> diff --git a/poky/documentation/ref-manual/ref-terms.xml b/poky/documentation/ref-manual/ref-terms.xml index f98546826..722fa7ee2 100644 --- a/poky/documentation/ref-manual/ref-terms.xml +++ b/poky/documentation/ref-manual/ref-terms.xml @@ -41,11 +41,13 @@ That append file would match any <filename>busybox_1.21.</filename><replaceable>x</replaceable><filename>.bb</filename> version of the recipe. - So, the append file would match the following recipe names: + So, the append file would match any of the following recipe names: <literallayout class='monospaced'> busybox_1.21.1.bb busybox_1.21.2.bb busybox_1.21.3.bb + busybox_1.21.10.bb + busybox_1.21.25.bb </literallayout> <note><title>Important</title> The use of the "<filename>%</filename>" character @@ -115,7 +117,7 @@ in your home directory within the existing directory <filename>mybuilds</filename>: <literallayout class='monospaced'> - $cd $HOME + $ cd $HOME $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION; </literallayout> </para></listitem> @@ -141,7 +143,7 @@ The system used to build images in a Yocto Project Development environment. The build system is sometimes referred to as the - development host. + <firstterm>development host</firstterm>. </para></listitem> <listitem><para> <emphasis>Classes:</emphasis> @@ -393,7 +395,7 @@ Poky is not a product level distro. Rather, it is a good starting point for customization. <note> - Poky began an open-source + Poky began as an open-source project initially developed by OpenedHand. OpenedHand developed Poky from the existing OpenEmbedded build system to create a commercially diff --git a/poky/documentation/ref-manual/ref-variables.xml b/poky/documentation/ref-manual/ref-variables.xml index 02abc590c..657f6cf3d 100644 --- a/poky/documentation/ref-manual/ref-variables.xml +++ b/poky/documentation/ref-manual/ref-variables.xml @@ -52,7 +52,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi"). @@ -76,7 +75,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies whether to produce an output package even if it is empty. By default, BitBake does not produce empty packages. @@ -103,7 +101,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists commands in a package that need an alternative binary naming scheme. Sometimes the same command is provided in multiple packages. @@ -134,7 +131,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used by the alternatives system to map duplicated commands to actual locations. For example, if the <filename>bracket</filename> command @@ -174,7 +170,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used by the alternatives system to create default priorities for duplicated commands. You can use the variable to create a single default @@ -203,7 +198,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used by the alternatives system to create default link locations for duplicated commands. You can use the variable to create a single default @@ -258,7 +252,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An override list of append strings for each target specified with <link linkend='var-LABELS'><filename>LABELS</filename></link>. @@ -278,7 +271,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments used to run <filename>ar</filename>. </para> @@ -291,7 +283,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used with the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> class, determines the type of information used to create @@ -334,7 +325,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Minimal command and arguments needed to run the assembler. </para> @@ -347,7 +337,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists recipe names (<link linkend='var-PN'><filename>PN</filename></link> values) BitBake does not attempt to build. @@ -367,11 +356,10 @@ <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm> <info> - ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." + ASSUME_SHLIBS[doc] = "Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Provides additional <filename>shlibs</filename> provider mapping information, which adds to or overwrites the information provided automatically by the system. @@ -406,7 +394,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The email address used to contact the original author or authors in order to send patches and forward bugs. </para> @@ -419,7 +406,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When the <link linkend='ref-classes-debian'><filename>debian</filename></link> class is inherited, which is the default behavior, @@ -442,7 +428,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Enables creating an automatic menu for the syslinux bootloader. You must set this variable in your recipe. @@ -459,7 +444,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When <filename><link linkend='var-SRCREV'>SRCREV</link></filename> is set to the value of this variable, it specifies to use @@ -495,13 +479,35 @@ </glossdef> </glossentry> + <glossentry id='var-AVAILABLE_LICENSES'><glossterm>AVAILABLE_LICENSES</glossterm> + <info> + AVAILABLE_LICENSES[doc] = "List of licenses found in the directories specified by COMMON_LICENSE_DIR and LICENSE_PATH." + </info> + <glossdef> + <para role="glossdeffirst"> + + List of licenses found in the directories specified + by <link linkend='var-COMMON_LICENSE_DIR'><filename>COMMON_LICENSE_DIR</filename></link> + and <link linkend='var-LICENSE_PATH'><filename>LICENSE_PATH</filename></link>. + + <note> + It is assumed that all changes + to <filename>COMMON_LICENSE_DIR</filename> + and <filename>LICENSE_PATH</filename> have been done + before <filename>AVAILABLE_LICENSES</filename> is + defined + (in <link linkend='ref-classes-license'>license.bbclass</link>). + </note> + </para> + </glossdef> + </glossentry> + <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm> <info> AVAILTUNES[doc] = "The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system. @@ -536,7 +542,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory within the <link linkend='build-directory'>Build Directory</link> in which the OpenEmbedded build system places generated @@ -566,7 +571,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists "recommended-only" packages to not install. Recommended-only packages are packages installed only through the @@ -621,7 +625,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The library directory name for the CPU or Application Binary Interface (ABI) tune. The <filename>BASE_LIB</filename> applies only in the @@ -647,7 +650,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the base of the work directory for all recipes. The default value is "${TMPDIR}/work". </para> @@ -727,7 +729,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines how BitBake handles situations where an append file (<filename>.bbappend</filename>) has no corresponding recipe file (<filename>.bb</filename>). @@ -765,7 +766,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Monitors disk space and available inodes during the build and allows you to control the build based on these parameters. @@ -863,7 +863,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the disk space and free inode warning intervals. To set these intervals, define the variable in your <filename>conf/local.conf</filename> file in the @@ -935,7 +934,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Causes tarballs of the source control repositories (e.g. Git repositories), including metadata, to be placed in the @@ -970,7 +968,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The maximum number of tasks BitBake should run in parallel at any one time. The OpenEmbedded build system automatically configures @@ -1006,7 +1003,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the time (in seconds) after which to unload the BitBake server due to inactivity. Set <filename>BB_SERVER_TIMEOUT</filename> to determine how @@ -1032,7 +1028,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>, which is a copy of Quilt built to run on the build system; @@ -1083,7 +1078,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the names of configured layers. These names are used to find the other <filename>BBFILE_*</filename> variables. @@ -1099,7 +1093,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Variable that expands to match files from <link linkend='var-BBFILES'><filename>BBFILES</filename></link> in a particular layer. @@ -1116,7 +1109,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Assigns the priority for recipe files in each layer. </para> @@ -1159,7 +1151,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of recipe files BitBake uses to build software. </para> @@ -1181,7 +1172,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Activates content when identified layers are present. You identify the layers by the collections that the layers define. @@ -1228,7 +1218,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Variable that controls how BitBake displays logs on build failure. </para> </glossdef> @@ -1240,7 +1229,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link> is set, specifies the maximum number of lines from the @@ -1257,7 +1245,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the layers to enable during the build. This variable is defined in the <filename>bblayers.conf</filename> configuration file in the @@ -1286,7 +1273,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Prevents BitBake from processing recipes and recipe append files. </para> @@ -1348,7 +1334,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies each additional separate configuration when you are building targets with multiple configurations. Use this variable in your @@ -1384,7 +1369,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used by BitBake to locate <filename>.bbclass</filename> and configuration files. This variable is analogous to the @@ -1413,7 +1397,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If defined in the BitBake environment, <filename>BBSERVER</filename> points to the BitBake remote server. @@ -1423,7 +1406,7 @@ Use the following format to export the variable to the BitBake environment: <literallayout class='monospaced'> - export BBSERVER=localhost:$port" + export BBSERVER=localhost:$port </literallayout> </para> @@ -1442,7 +1425,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link> class, this variable specifies binary configuration @@ -1470,7 +1452,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> class, this variable specifies a wildcard for @@ -1509,7 +1490,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base recipe name and version but without any special recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, and so forth). @@ -1527,7 +1507,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable is a version of the <link linkend='var-PN'><filename>PN</filename></link> variable with common prefixes and suffixes @@ -1552,7 +1531,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a URL for an upstream bug tracking website for a recipe. The OpenEmbedded build system does not use this variable. @@ -1568,7 +1546,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the architecture of the build host (e.g. <filename>i686</filename>). The OpenEmbedded build system sets the value of @@ -1584,7 +1561,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the architecture-specific assembler flags for the build host. By default, the value of <filename>BUILD_AS_ARCH</filename> is empty. @@ -1598,7 +1574,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the architecture-specific C compiler flags for the build host. By default, the value of <filename>BUILD_CC_ARCH</filename> is empty. @@ -1612,7 +1587,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the linker command to be used for the build host when the C compiler is being used as the linker. By default, <filename>BUILD_CCLD</filename> points to GCC and passes as @@ -1629,7 +1603,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C compiler when building for the build host. When building in the <filename>-native</filename> context, @@ -1645,7 +1618,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C preprocessor (i.e. to both the C and the C++ compilers) when building for the build host. @@ -1662,7 +1634,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C++ compiler when building for the build host. When building in the <filename>-native</filename> context, @@ -1678,7 +1649,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the Fortran compiler command for the build host. By default, <filename>BUILD_FC</filename> points to Gfortran and passes as arguments the value of @@ -1694,7 +1664,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the linker command for the build host. By default, <filename>BUILD_LD</filename> points to the GNU linker (ld) and passes as arguments the value of @@ -1710,7 +1679,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific linker flags for the build host. By default, the value of <filename>BUILD_LD_ARCH</filename> is empty. @@ -1724,7 +1692,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the linker when building for the build host. When building in the <filename>-native</filename> context, @@ -1740,7 +1707,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the optimization flags passed to the C compiler when building for the build host or the SDK. The flags are passed through the @@ -1764,7 +1730,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the operating system in use on the build host (e.g. "linux"). The OpenEmbedded build system sets the value of @@ -1781,7 +1746,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The toolchain binary prefix used for native recipes. The OpenEmbedded build system uses the <filename>BUILD_PREFIX</filename> value to set the @@ -1797,7 +1761,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the command to be used to strip debugging symbols from binaries produced for the build host. By default, <filename>BUILD_STRIP</filename> points to @@ -1812,7 +1775,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the system, including the architecture and the operating system, to use when building for the build host (i.e. when building <filename>native</filename> @@ -1838,7 +1800,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the vendor name to use when building for the build host. The default value is an empty string (""). @@ -1852,7 +1813,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the location of the <link linkend='build-directory'>Build Directory</link>. You can define this directory indirectly through the @@ -1872,7 +1832,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies whether or not to commit the @@ -1904,7 +1863,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the author to use for each @@ -1939,7 +1897,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the directory in which @@ -1964,7 +1921,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies the build history features @@ -2017,7 +1973,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable specifies a list of paths to files @@ -2050,7 +2005,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> class, this variable optionally specifies a remote @@ -2085,7 +2039,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C compiler when building for the SDK. When building in the <filename>nativesdk-</filename> @@ -2102,7 +2055,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK. @@ -2120,7 +2072,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C++ compiler when building for the SDK. When building in the <filename>nativesdk-</filename> @@ -2137,7 +2088,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the linker when building for the SDK. When building in the <filename>nativesdk-</filename> @@ -2154,7 +2104,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the location of the directory that holds build statistics when you use and enable the <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> @@ -2172,7 +2121,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require <filename>setuid root</filename>, and one for @@ -2200,7 +2148,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the directory BitBake uses to store a cache of the <link linkend='metadata'>Metadata</link> @@ -2216,7 +2163,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments used to run the C compiler. </para> @@ -2229,7 +2175,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C compiler. This variable is exported to an environment variable and thus made visible to the software being @@ -2265,7 +2210,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth). @@ -2309,7 +2253,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1" within a recipe, <filename>CLEANBROKEN</filename> specifies that the <filename>make clean</filename> command does @@ -2328,7 +2271,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Provides a list of hardware features that are enabled in both <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> @@ -2351,7 +2293,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to <filename>meta/files/common-licenses</filename> in the <link linkend='source-directory'>Source Directory</link>, @@ -2366,7 +2307,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible. @@ -2389,7 +2329,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A regular expression that resolves to one or more target machines with which a recipe is compatible. The regular expression is matched against @@ -2410,7 +2349,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines wildcards to match when installing a list of complementary packages for all the packages explicitly (or implicitly) installed in an image. @@ -2449,7 +2387,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Stores sysroot components for each recipe. The OpenEmbedded build system uses <filename>COMPONENTS_DIR</filename> when constructing @@ -2470,7 +2407,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Tracks the version of the local configuration file (i.e. <filename>local.conf</filename>). The value for <filename>CONF_VERSION</filename> @@ -2486,7 +2422,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Identifies editable or configurable files that are part of a package. If the Package Management System (PMS) is being used to update packages on the target system, it is possible that @@ -2540,7 +2475,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Identifies the initial RAM filesystem (initramfs) source files. The OpenEmbedded build system receives and uses @@ -2583,7 +2517,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of files that contains <filename>autoconf</filename> test results relevant to the current build. This variable is used by the Autotools utilities when running @@ -2598,7 +2531,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal arguments for GNU configure. </para> </glossdef> @@ -2610,7 +2542,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> class, this @@ -2633,7 +2564,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of licenses to exclude from the source archived by the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> @@ -2665,7 +2595,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of licenses to include in the source archived by the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> @@ -2693,7 +2622,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recipes to exclude in the source archived by the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> @@ -2725,7 +2653,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recipes to include in the source archived by the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> @@ -2757,7 +2684,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of recipe types to include in the source archived by the <link linkend='ref-classes-archiver'><filename>archiver</filename></link> @@ -2787,7 +2713,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1" along with the <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> variable, the OpenEmbedded build system copies @@ -2819,7 +2744,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1", the OpenEmbedded build system copies the license manifest for the image to <filename>/usr/share/common-licenses/license.manifest</filename> @@ -2847,7 +2771,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the list of packages to be added to the image. You should only set this variable in the <filename>local.conf</filename> configuration file found @@ -2867,7 +2790,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the parent directory of the OpenEmbedded-Core Metadata layer (i.e. <filename>meta</filename>). </para> @@ -2893,7 +2815,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists files from the <link linkend='var-COREBASE'><filename>COREBASE</filename></link> directory that should be copied other than the layers @@ -2922,7 +2843,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments used to run the C preprocessor. </para> @@ -2935,7 +2855,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers). This variable is exported to an environment @@ -2972,7 +2891,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The toolchain binary prefix for the target tools. The <filename>CROSS_COMPILE</filename> variable is the same as the @@ -2994,7 +2912,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory in which files checked out under the CVS system are stored. </para> @@ -3007,7 +2924,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments used to run the C++ compiler. </para> @@ -3020,7 +2936,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C++ compiler. This variable is exported to an environment variable and thus made visible to the software being @@ -3060,7 +2975,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The destination directory. The location in the <link linkend='build-directory'>Build Directory</link> @@ -3086,7 +3000,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The date the build was started. Dates appear using the year, month, and day (YMD) format (e.g. "20150209" for February 9th, 2015). @@ -3100,7 +3013,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The date and time on which the current build started. The format is suitable for timestamps. </para> @@ -3113,7 +3025,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When the <link linkend='ref-classes-debian'><filename>debian</filename></link> class is inherited, which is the default behavior, @@ -3137,7 +3048,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When the <link linkend='ref-classes-debian'><filename>debian</filename></link> class is inherited, which is the default behavior, @@ -3161,7 +3071,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies to build packages with debugging information. This influences the value of the <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> @@ -3176,7 +3085,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The options to pass in <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling @@ -3192,7 +3100,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a weak bias for recipe selection priority. </para> @@ -3222,7 +3129,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. @@ -3247,7 +3153,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists a recipe's build-time dependencies. These are dependencies on other recipes whose contents (e.g. headers and shared libraries) are needed @@ -3370,7 +3275,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system. @@ -3402,7 +3306,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the area that the OpenEmbedded build system uses to place Debian packages that are ready to be used outside of the build system. @@ -3442,7 +3345,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine. @@ -3475,7 +3377,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the area that the OpenEmbedded build system uses to place IPK packages that are ready to be used outside of the build system. @@ -3514,7 +3415,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the area that the OpenEmbedded build system uses to place RPM packages that are ready to be used outside of the build system. @@ -3553,7 +3453,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the area that the OpenEmbedded build system uses to place tarballs that are ready to be used outside of the build system. @@ -3592,7 +3491,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-deploy'><filename>deploy</filename></link> class, the <filename>DEPLOYDIR</filename> points to a @@ -3620,7 +3518,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The package description used by package managers. If not set, <filename>DESCRIPTION</filename> takes the value of the @@ -3636,7 +3533,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The short name of the distribution. For information on the long name of the distribution, see the @@ -3689,7 +3585,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a codename for the distribution being built. </para> </glossdef> @@ -3701,7 +3596,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of distro-specific packages to add to all images. This variable takes affect through <filename>packagegroup-base</filename> so the @@ -3721,7 +3615,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of distro-specific packages to add to all images if the packages exist. The packages might not exist or be empty (e.g. kernel modules). @@ -3737,7 +3630,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The software support you want in your distribution for various features. You define your distribution features in the distribution @@ -3774,7 +3666,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Features to be added to <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> if not also present in @@ -3786,7 +3677,7 @@ It is not intended to be user-configurable. It is best to just reference the variable to see which distro features are being backfilled for all distro configurations. - See the <link linkend='ref-features-backfill'>Feature Backfilling</link> section for + See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for more information. </para> </glossdef> @@ -3798,7 +3689,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Features from <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename> that should not be backfilled (i.e. added to @@ -3816,7 +3706,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A convenience variable that gives you the default list of distro features with the exception of any features specific to the C library @@ -3844,7 +3733,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of features that if present in the target <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> @@ -3865,7 +3753,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of features that if present in the target <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> value should be included in @@ -3886,7 +3773,6 @@ </info> <glossdef> <para role="glossdeffirst"> - <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> A convenience variable that specifies the list of distro features that are specific to the C library (<filename>libc</filename>). @@ -3904,7 +3790,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of features that should be included in <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> when building native recipes. @@ -3922,7 +3807,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of features that should be included in <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> when building nativesdk recipes. @@ -3940,7 +3824,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The long name of the distribution. For information on the short name of the distribution, see the @@ -3992,7 +3875,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The version of the distribution. </para> </glossdef> @@ -4004,7 +3886,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A colon-separated list of overrides specific to the current distribution. By default, this list includes the value of @@ -4032,7 +3913,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The central download directory used by the build process to store downloads. By default, <filename>DL_DIR</filename> gets files @@ -4095,7 +3975,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link> class, this variable sets the compression policy used when @@ -4123,7 +4002,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When building bootable images (i.e. where <filename>hddimg</filename>, <filename>iso</filename>, or <filename>wic.vmdk</filename> is in @@ -4150,7 +4028,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Variable that controls which locales for <filename>glibc</filename> are generated during the build (useful if the target device has 64Mbytes @@ -4165,7 +4042,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used with the <link linkend='ref-classes-report-error'><filename>report-error</filename></link> class, specifies the path used for storing the debug files @@ -4194,7 +4070,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the quality assurance checks whose failures are reported as errors by the OpenEmbedded build system. You set this variable in your distribution configuration @@ -4213,7 +4088,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Triggers the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries. @@ -4252,7 +4126,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Directs BitBake to exclude a recipe from world builds (i.e. <filename>bitbake world</filename>). During world builds, BitBake locates, parses and builds all @@ -4282,7 +4155,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used with file and pathnames to create a prefix for a recipe's version based on the recipe's <link linkend='var-PE'><filename>PE</filename></link> value. @@ -4304,7 +4176,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The full package version specification as it appears on the final packages produced by a recipe. The variable's value is normally used to fix a runtime @@ -4329,7 +4200,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When set, the <filename>EXTERNAL_KERNEL_TOOLS</filename> variable indicates that these tools are not in the source tree. @@ -4355,7 +4225,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> class, this variable points to the source tree, which is @@ -4385,7 +4254,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> class, this variable points to the directory in which the @@ -4416,7 +4284,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For recipes inheriting the <link linkend='ref-classes-autotools'><filename>autotools</filename></link> class, you can use <filename>EXTRA_AUTORECONF</filename> to @@ -4439,7 +4306,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of additional features to include in an image. When listing more than one feature, separate them with a space. @@ -4520,7 +4386,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies additional options for the image creation command that has been specified in <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>. @@ -4540,7 +4405,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recipes to build that do not provide packages for installing into the root filesystem. </para> @@ -4568,7 +4432,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of subdirectories of <filename>${</filename><link linkend='var-STAGING_BINDIR_NATIVE'><filename>STAGING_BINDIR_NATIVE</filename></link><filename>}</filename> added to the beginning of the environment variable @@ -4589,7 +4452,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Additional <ulink url='https://cmake.org/overview/'>CMake</ulink> options. @@ -4606,7 +4468,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Additional <filename>configure</filename> script options. See <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> @@ -4622,7 +4483,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Additional GNU <filename>make</filename> options. </para> @@ -4649,7 +4509,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-scons'><filename>scons</filename></link> class, this variable specifies additional configuration @@ -4665,7 +4524,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link> class, this variable provides image level user and group @@ -4707,7 +4565,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines one or more packages to include in an image when a specific item is included in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. @@ -4742,7 +4599,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the base URL of the server and location within the document-root that provides the metadata and packages required by OPKG to support runtime package @@ -4773,7 +4629,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of files and directories that are placed in a package. The @@ -4844,7 +4699,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the file specification to match <link linkend='var-SOLIBSDEV'><filename>SOLIBSDEV</filename></link>. In other words, <filename>FILES_SOLIBSDEV</filename> @@ -4868,7 +4722,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files. @@ -4965,7 +4818,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> used by the OpenEmbedded build system for creating <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. @@ -5005,7 +4857,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The default set of directories the OpenEmbedded build system uses when searching for patches and files. </para> @@ -5106,7 +4957,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Allows you to define your own file permissions settings table as part of your configuration for the packaging process. For example, suppose you need a consistent set of custom permissions for @@ -5146,7 +4996,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> class, this variable specifies the runtime dependencies @@ -5163,7 +5012,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> class, this variable identifies packages containing font @@ -5183,7 +5031,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Forces the removal of the packages listed in <filename>ROOTFS_RO_UNNEEDED</filename> during the generation of the root filesystem. @@ -5202,7 +5049,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The options to pass in <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> @@ -5222,7 +5068,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Enables Position Independent Executables (PIE) within the GNU C Compiler (GCC). Enabling PIE in the GCC makes Return Oriented Programming @@ -5246,7 +5091,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the default version of the GNU C Compiler (GCC) used for compilation. By default, <filename>GCCVERSION</filename> is set to @@ -5268,7 +5112,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run the GNU Debugger. </para> </glossdef> @@ -5280,7 +5123,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory in which a local copy of a Git repository is stored when it is cloned. </para> @@ -5293,7 +5135,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the list of GLIBC locales to generate should you not wish to generate all LIBC locals, which can be time consuming. @@ -5322,7 +5163,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -5351,7 +5191,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -5375,7 +5214,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu. Set this variable to "1" in your @@ -5398,7 +5236,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration. Use a semi-colon character (<filename>;</filename>) to @@ -5420,7 +5257,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the timeout before executing the default <filename>LABEL</filename> in the GNU GRand Unified Bootloader (GRUB). @@ -5441,7 +5277,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link> class, this variable specifies the packages that contain the @@ -5461,7 +5296,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Website where more information about the software the recipe is building can be found. </para> @@ -5475,7 +5309,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The name of the target architecture, which is normally the same as <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. @@ -5503,7 +5336,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific compiler flags that are passed to the C compiler. </para> @@ -5537,7 +5369,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the target operating system, which is normally the same as the <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>. @@ -5555,7 +5386,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the prefix for the cross-compile toolchain. <filename>HOST_PREFIX</filename> is normally the same as <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>. @@ -5569,7 +5399,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the system, including the architecture and the operating system, for which the build is occurring in the context of the current recipe. @@ -5610,7 +5439,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks. Using this filter helps reduce the possibility of host @@ -5634,7 +5462,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks. Using this filter helps reduce the possibility of host @@ -5657,7 +5484,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the vendor. <filename>HOST_VENDOR</filename> is normally the same as <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>. @@ -5675,7 +5501,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Disables or enables the <filename>icecc</filename> (Icecream) function. For more information on this function and best practices @@ -5704,7 +5529,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the <filename>icecc-create-env</filename> script that you provide. This variable is used by the @@ -5730,7 +5554,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extra options passed to the <filename>make</filename> command during the <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> @@ -5776,7 +5599,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location of the <filename>icecc</filename> binary. You can set this variable in your <filename>local.conf</filename> file. @@ -5795,7 +5617,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Identifies user classes that you do not want the Icecream distributed compile support to consider. This variable is used by the @@ -5821,7 +5642,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Identifies user recipes that you do not want the Icecream distributed compile support to consider. This variable is used by the @@ -5847,7 +5667,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Identifies user recipes that use an empty <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> variable that you want to force remote distributed @@ -5868,7 +5687,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of image output files. This variable defaults to the recipe name (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). @@ -5882,7 +5700,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of files installed into the boot partition when preparing an image using the Wic tool with the <filename>bootimg-partition</filename> source @@ -5939,7 +5756,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of classes that all images should inherit. You typically use this variable to specify the list of classes that register the different types of images @@ -5968,7 +5784,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the command to create the image file for a specific image type, which corresponds to the value set set in @@ -6002,7 +5817,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies one or more files that contain custom device tables that are passed to the <filename>makedevs</filename> command as part of creating @@ -6026,7 +5840,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The primary list of features to include in an image. Typically, you configure this variable in an image recipe. Although you can use this variable from your @@ -6062,7 +5875,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the formats the OpenEmbedded build system uses during the build when creating the root filesystem. For example, setting <filename>IMAGE_FSTYPES</filename> @@ -6110,7 +5922,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Used by recipes to specify the packages to install into an image through the <link linkend='ref-classes-image'><filename>image</filename></link> @@ -6196,7 +6007,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the list of locales to install into the image during the root filesystem construction process. The OpenEmbedded build system automatically splits locale @@ -6238,7 +6048,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The manifest file for the image. This file lists all the installed packages that make up the image. @@ -6275,7 +6084,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The name of the output image files minus the extension. This variable is derived using the <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, @@ -6296,7 +6104,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of @@ -6342,7 +6149,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system. The variable is defined appropriately by the @@ -6394,7 +6200,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call once the OpenEmbedded build system creates the final image output files. @@ -6422,7 +6227,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call before the OpenEmbedded build system creates the final image output files. @@ -6450,7 +6254,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location of the root filesystem while it is under construction (i.e. during the <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> @@ -6467,7 +6270,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the alignment for the output image file in Kbytes. If the size of the image is not a multiple of @@ -6487,7 +6289,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines additional free disk space created in the image in Kbytes. By default, this variable is set to "0". This free disk space is added to the image after the build system determines @@ -6522,7 +6323,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the size in Kbytes for the generated image. The OpenEmbedded build system determines the final size for the generated image using an algorithm that takes into account the initial disk space used @@ -6572,7 +6372,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a dependency from one image type on another. Here is an example from the <link linkend='ref-classes-image-live'><filename>image-live</filename></link> @@ -6602,7 +6401,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the complete list of supported image types by default: <literallayout class='monospaced'> @@ -6614,7 +6412,6 @@ cpio.lzma cpio.xz cramfs - elf ext2 ext2.bz2 ext2.gz @@ -6638,6 +6435,7 @@ tar.gz tar.lz4 tar.xz + tar.zst ubi ubifs wic @@ -6662,7 +6460,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Helps define the recipe revision for recipes that share a common <filename>include</filename> file. You can think of this variable as part of the recipe revision @@ -6728,7 +6525,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a space-separated list of license names (as they would appear in <link linkend='var-LICENSE'><filename>LICENSE</filename></link>) @@ -6750,6 +6546,25 @@ components that are required to produce a functional system image. </note> + + <note><title>Tips</title> + It is possible to define a list of licenses that are allowed + to be used instead of the licenses that are excluded. To do + this, define a + variable <filename>COMPATIBLE_LICENSES</filename> with the + names of the licences that are allowed. Then + define <filename>INCOMPATIBLE_LICENSE</filename> as: + <literallayout class='monospaced'> + INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" + </literallayout> + This will result + in <filename>INCOMPATIBLE_LICENSE</filename> containing the + names of all licences + from <link linkend='var-AVAILABLE_LICENSES'><filename>AVAILABLE_LICENSES</filename></link> + except the ones specified + in <filename>COMPATIBLE_LICENSES</filename>, thus only + allowing the latter licences to be used. + </note> </glossdef> </glossentry> @@ -6759,7 +6574,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Causes the named class or classes to be inherited globally. Anonymous functions in the class or classes are not executed for the @@ -6783,7 +6597,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable. @@ -6806,7 +6619,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. @@ -6827,7 +6639,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Prevents the OpenEmbedded build system from splitting out debug information during packaging. By default, the build system splits out debugging @@ -6858,7 +6669,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1", causes the build to not strip binaries in resulting packages and prevents the <filename>-dbg</filename> package from containing the @@ -6882,7 +6692,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1", causes the build to not strip binaries in the resulting sysroot. </para> @@ -6920,7 +6729,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot. Supported formats are the same as those supported by the @@ -6949,7 +6757,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> name of an image recipe that is used to build an initial @@ -7017,7 +6824,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls whether or not the image recipe specified by <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> is run through an extra pass @@ -7083,7 +6889,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The link name of the initial RAM filesystem image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7113,7 +6918,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of the initial RAM filesystem image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7138,7 +6942,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Indicates list of filesystem images to concatenate and use as an initial RAM disk (<filename>initrd</filename>). </para> @@ -7158,7 +6961,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When building a "live" bootable image (i.e. when <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> contains "live"), <filename>INITRD_IMAGE</filename> @@ -7181,7 +6983,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The filename of the initialization script as installed to <filename>${sysconfdir}/init.d</filename>. </para> @@ -7199,7 +7000,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of the packages that contain initscripts. If multiple packages are specified, you need to append the package name to the other <filename>INITSCRIPT_*</filename> as an override. @@ -7219,7 +7019,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the options to pass to <filename>update-rc.d</filename>. Here is an example: <literallayout class='monospaced'> @@ -7257,7 +7056,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the QA checks to skip for a specific package within a recipe. For example, to skip the check for symbolic link @@ -7284,7 +7082,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> By default, the <filename>tzdata</filename> recipe packages an <filename>/etc/timezone</filename> file. Set the <filename>INSTALL_TIMEZONE_FILE</filename> @@ -7300,7 +7097,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When the IPK backend is in use and package management is enabled on the target, you can use this variable to set up <filename>opkg</filename> in the target image @@ -7360,7 +7156,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the kernel architecture used when assembling the configuration. Architectures supported for this release are: @@ -7387,7 +7182,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched, and configured during a build. @@ -7428,7 +7222,6 @@ KBRANCH_genericx86-64 = "standard/base" KBRANCH_edgerouter = "standard/edgerouter" KBRANCH_beaglebone = "standard/beaglebone" - KBRANCH_mpc8315e-rdb = "standard/fsl-mpc8315e-rdb" </literallayout> The <filename>KBRANCH</filename> statements identify the kernel branch to use when building for each @@ -7443,7 +7236,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used with the <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> class, specifies an "in-tree" kernel configuration file @@ -7499,7 +7291,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies an alternate kernel image type for creation in addition to the kernel image type specified using the <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> @@ -7514,7 +7305,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of all of the build artifacts. You can change the name of the artifacts by changing the <filename>KERNEL_ARTIFACT_NAME</filename> variable. @@ -7553,7 +7343,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of classes defining kernel image types that the <link linkend='ref-classes-kernel'><filename>kernel</filename></link> class should inherit. @@ -7574,7 +7363,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the generated Linux kernel device tree (i.e. the <filename>.dtb</filename>) file. <note> @@ -7596,7 +7384,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The link name of the kernel device tree binary (DTB). This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7626,7 +7413,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of the kernel device tree binary (DTB). This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7651,7 +7437,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies additional <filename>make</filename> command-line arguments the OpenEmbedded build system passes on when compiling the kernel. @@ -7665,7 +7450,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Includes additional kernel metadata. In the OpenEmbedded build system, the default Board Support Packages (BSPs) @@ -7714,7 +7498,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The link name of the kernel flattened image tree (FIT) image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7744,7 +7527,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of the kernel flattened image tree (FIT) image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7769,7 +7551,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The link name for the kernel image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7799,7 +7580,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the maximum size of the kernel image file in kilobytes. If <filename>KERNEL_IMAGE_MAXSIZE</filename> is set, @@ -7830,7 +7610,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of the kernel image. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -7855,7 +7634,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The type of kernel to build for a device, usually set by the machine configuration files and defaults to "zImage". This variable is used @@ -7877,7 +7655,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists kernel modules that need to be auto-loaded during boot. <note> @@ -7931,7 +7708,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Provides a list of modules for which the OpenEmbedded build system expects to find <filename>module_conf_</filename><replaceable>modname</replaceable> @@ -7950,7 +7726,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location of the kernel sources. This variable is set to the value of the <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> @@ -7982,7 +7757,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location of the kernel sources. This variable is set to the value of the <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> @@ -8014,7 +7788,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the version of the kernel as extracted from <filename>version.h</filename> or <filename>utsrelease.h</filename> within the kernel sources. @@ -8032,7 +7805,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies whether the data referenced through <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> is needed or not. @@ -8054,7 +7826,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Provides a short description of a configuration fragment. You use this variable in the <filename>.scc</filename> file that describes a configuration fragment file. @@ -8074,7 +7845,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The machine as known by the kernel. Sometimes the machine name used by the kernel does not match the machine name used by the OpenEmbedded build @@ -8121,7 +7891,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", @@ -8151,7 +7920,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Provides a list of targets for automatic configuration. </para> @@ -8169,7 +7937,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the layers, separated by spaces, on which this recipe depends. Optionally, you can specify a specific layer version for a @@ -8200,7 +7967,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used inside the <filename>layer.conf</filename> configuration file, this variable provides the path of the current layer. This variable is not available outside of <filename>layer.conf</filename> @@ -8215,7 +7981,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the layers, separated by spaces, recommended for use with this layer. </para> @@ -8248,7 +8013,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists the versions of the <link linkend='oe-core'>OpenEmbedded-Core</link> for which a layer is compatible. @@ -8295,7 +8059,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Optionally specifies the version of a layer as a single number. You can use this within <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> @@ -8314,7 +8077,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments used to run the linker. </para> @@ -8327,7 +8089,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the linker. This variable is exported to an environment variable and thus made visible to the software being @@ -8363,7 +8124,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the lead (or primary) compiled library file (i.e. <filename>.so</filename>) that the <link linkend='ref-classes-debian'><filename>debian</filename></link> @@ -8384,7 +8144,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Checksums of the license text in the recipe source code. </para> @@ -8413,7 +8172,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of source licenses for the recipe. Follow these rules: <itemizedlist> @@ -8478,7 +8236,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Setting <filename>LICENSE_CREATE_PACKAGE</filename> to "1" causes the OpenEmbedded build system to create an extra package (i.e. @@ -8521,7 +8278,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies additional flags for a recipe you must whitelist through <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> @@ -8549,7 +8305,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists license flags that when specified in <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> within a recipe should not prevent that recipe from being @@ -8569,7 +8324,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Path to additional licenses used during the build. By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> to define the directory that holds common license text used during the build. @@ -8588,7 +8342,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the kernel type to be used in assembling the configuration. The linux-yocto recipes define "standard", "tiny", and @@ -8621,7 +8374,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The Linux version from <filename>kernel.org</filename> on which the Linux kernel image being built using the OpenEmbedded build system is based. @@ -8652,7 +8404,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. @@ -8685,7 +8436,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is <filename>${TMPDIR}/log</filename>. @@ -8709,7 +8459,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the target device for which the image is built. You define <filename>MACHINE</filename> in the <filename>local.conf</filename> file found in the @@ -8746,7 +8495,6 @@ MACHINE ?= "genericx86" MACHINE ?= "genericx86-64" MACHINE ?= "beaglebone" - MACHINE ?= "mpc8315e-rdb" MACHINE ?= "edgerouter" </literallayout> The last five are Yocto Project reference hardware boards, which @@ -8765,7 +8513,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the machine-specific architecture. This variable is set automatically from <link linkend='var-MACHINE'><filename>MACHINE</filename></link> @@ -8783,7 +8530,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of required machine-specific packages to install as part of the image being built. The build process depends on these packages being present. @@ -8820,7 +8566,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recommended machine-specific packages to install as part of the image being built. The build process does not depend on these packages being present. @@ -8884,7 +8629,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images @@ -8930,7 +8674,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependency on this list of packages. @@ -8975,7 +8718,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the list of hardware features the <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable of supporting. @@ -9002,7 +8744,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Features to be added to <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> if not also present in @@ -9026,7 +8767,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Features from <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename> that should not be backfilled (i.e. added to @@ -9044,7 +8784,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A colon-separated list of overrides that apply to the current machine. By default, this list includes the value of @@ -9085,7 +8824,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The email address of the distribution maintainer. </para> </glossdef> @@ -9097,7 +8835,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies additional paths from which the OpenEmbedded build system gets source code. When the build system searches for source code, it first @@ -9126,7 +8863,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a prefix has been added to <link linkend='var-PN'><filename>PN</filename></link> to create a special version of a recipe or package (i.e. a Multilib version). @@ -9178,7 +8914,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable has been replaced by the <filename>KERNEL_MODULE_AUTOLOAD</filename> variable. You should replace all occurrences of @@ -9207,7 +8942,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink> syntax lines for inclusion in the @@ -9268,7 +9002,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls creation of the <filename>modules-*.tgz</filename> file. Set this variable to "0" to disable creation of this @@ -9284,7 +9017,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The link name of the kernel module tarball. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -9314,7 +9046,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name of the kernel module tarball. This variable is set in the <filename>meta/classes/kernel-artifact-names.bbclass</filename> @@ -9341,7 +9072,6 @@ <glossdef> <para role="glossdeffirst"> --> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- Serves the same purpose as <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, @@ -9368,7 +9098,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Uniquely identifies the type of the target system for which packages are being built. This variable allows output for different types of target @@ -9407,7 +9136,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A string identifying the host distribution. Strings consist of the host distributor ID followed by the release, as reported by the @@ -9437,7 +9165,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run <filename>nm</filename>. </para> @@ -9450,7 +9177,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Avoids QA errors when you use a non-common, non-CLOSED license in a recipe. Packages exist, such as the linux-firmware package, with @@ -9484,7 +9210,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Prevents installation of all "recommended-only" packages. Recommended-only packages are packages installed only through the @@ -9545,7 +9270,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Disables auto package from splitting <filename>.debug</filename> files. If a recipe requires <filename>FILES_${PN}-dbg</filename> to be set manually, @@ -9571,7 +9295,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run <filename>objcopy</filename>. </para> @@ -9584,7 +9307,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run <filename>objdump</filename>. </para> @@ -9597,7 +9319,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> class, this variable @@ -9631,7 +9352,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system. @@ -9650,7 +9370,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK. @@ -9672,7 +9391,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls how the OpenEmbedded build system spawns interactive terminals on the host development system (e.g. using the BitBake command with the @@ -9704,7 +9422,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory from which the top-level build environment setup script is sourced. The Yocto Project provides a top-level build environment @@ -9728,7 +9445,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Declares the oldest version of the Linux kernel that the produced binaries must support. This variable is passed into the build of the Embedded @@ -9751,7 +9467,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A colon-separated list of overrides that currently apply. Overrides are a BitBake mechanism that allows variables to be selectively overridden at the end of parsing. @@ -9815,7 +9530,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The recipe name and version. <filename>P</filename> is comprised of the following: <literallayout class='monospaced'> @@ -9825,13 +9539,46 @@ </glossdef> </glossentry> + <glossentry id='var-PACKAGE_ADD_METADATA'><glossterm>PACKAGE_ADD_METADATA</glossterm> + <info> + PACKAGE_ADD_METADATA[doc] = "This variable defines additional metadata to add to packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable defines additional metdata to add to packages. + </para> + + <para> + You may find you need to inject additional metadata into + packages. This variable allows you to do that by setting + the injected data as the value. Multiple fields can be + added by splitting the content with the literal separator + "\n". + </para> + + <para> + The suffixes '_IPK', '_DEB', or '_RPM' can be applied to + the variable to do package type specific settings. It can + also be made package specific by using the package name as + a suffix. + </para> + + <para> + You can find out more about applying this variable in + the + "<ulink url='&YOCTO_DOCS_DEV_URL;#adding-custom-metadata-to-packages'>Adding custom metadata to packages</ulink>" + section in the Yocto Project Development Tasks Manual. + </para> + </glossdef> + </glossentry> + <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> <info> PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The architecture of the resulting package or packages. </para> @@ -9867,7 +9614,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of architectures compatible with the target machine. This variable is set automatically and should not @@ -9887,7 +9633,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Enables easily adding packages to <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> before <filename>${<link linkend='var-PN'>PN</link>}</filename> @@ -9903,7 +9648,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable, which is set in the <filename>local.conf</filename> configuration file found in the <filename>conf</filename> folder of the @@ -9953,7 +9697,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Determines how to split up the binary and debug information when creating <filename>*-dbg</filename> packages to be used with the GNU Project Debugger (GDB). @@ -10018,7 +9761,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Prevents specific packages from being installed when you are installing complementary packages. </para> @@ -10044,7 +9786,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists packages that should not be installed into an image. For example: <literallayout class='monospaced'> @@ -10096,7 +9837,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors such as XScale and ARM926-EJS. @@ -10110,7 +9850,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Optionally specifies the package architectures used as part of the package feed URIs during the build. When used, the <filename>PACKAGE_FEED_ARCHS</filename> @@ -10165,7 +9904,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the base path used when constructing package feed URIs. The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable @@ -10212,7 +9950,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the front portion of the package feed URI used by the OpenEmbedded build system. Each final package feed URI is comprised of @@ -10251,35 +9988,12 @@ </glossdef> </glossentry> - <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> - <info> - PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The <filename>PACKAGE_GROUP</filename> variable has been - renamed to - <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>. - See the variable description for - <filename>FEATURE_PACKAGES</filename> for information. - </para> - - <para> - If if you use the <filename>PACKAGE_GROUP</filename> - variable, the OpenEmbedded build system issues a warning - message. - </para> - </glossdef> - </glossentry> - <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm> <info> PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The final list of packages passed to the package manager for installation into the image. </para> @@ -10314,7 +10028,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of packages the OpenEmbedded build system attempts to install when creating an image. If a listed package fails to install, the build system @@ -10330,7 +10043,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions run to pre-process the <link linkend='var-PKGD'><filename>PKGD</filename></link> directory prior to splitting the files out to individual @@ -10345,7 +10057,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of dependencies for post-installation and pre-installation scripts on native/cross tools. If your post-installation or pre-installation script can @@ -10370,18 +10081,25 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis. <filename>PACKAGECONFIG</filename> blocks are defined in recipes when you specify features and then arguments that define feature behaviors. - Here is the basic block structure: + Here is the basic block structure (broken over multiple + lines for readability): <literallayout class='monospaced'> PACKAGECONFIG ??= "f1 f2 f3 ..." - PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1" - PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2" - PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3" + PACKAGECONFIG[f1] = "\ + --with-f1, \ + --without-f1, \ + build-deps-for-f1, \ + runtime-deps-for-f1, \ + runtime-recommends-for-f1, \ + packageconfig-conflicts-for-f1 \ + " + PACKAGECONFIG[f2] = "\ + ... and so on and so on ... </literallayout> </para> @@ -10390,7 +10108,7 @@ variable itself specifies a space-separated list of the features to enable. Following the features, you can determine the behavior of - each feature by providing up to five order-dependent + each feature by providing up to six order-dependent arguments, which are separated by commas. You can omit any argument you like but must retain the separating commas. @@ -10420,6 +10138,10 @@ (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>) that should be added if the feature is enabled. </para></listitem> + <listitem><para>Any conflicting (that is, mutually + exclusive) <filename>PACKAGECONFIG</filename> + settings for this feature. + </para></listitem> </orderedlist> </para> @@ -10427,25 +10149,23 @@ Consider the following <filename>PACKAGECONFIG</filename> block taken from the <filename>librsvg</filename> recipe. - In this example the feature is <filename>croco</filename>, + In this example the feature is <filename>gtk</filename>, which has three arguments that determine the feature's behavior. <literallayout class='monospaced'> - PACKAGECONFIG ??= "croco" - PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" + PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" </literallayout> - The <filename>--with-croco</filename> and - <filename>libcroco</filename> arguments apply only if + The <filename>--with-gtk3</filename> and + <filename>gtk+3</filename> arguments apply only if the feature is enabled. - In this case, <filename>--with-croco</filename> is + In this case, <filename>--with-gtk3</filename> is added to the configure script argument list and - <filename>libcroco</filename> is added to + <filename>gtk+3</filename> is added to <filename>DEPENDS</filename>. On the other hand, if the feature is disabled say through a <filename>.bbappend</filename> file in another layer, then - the second argument <filename>--without-croco</filename> is - added to the configure script rather than - <filename>--with-croco</filename>. + the second argument <filename>--without-gtk3</filename> is + added to the configure script instead. </para> <para> @@ -10499,7 +10219,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A space-separated list of configuration options generated from the <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> @@ -10530,7 +10249,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For recipes inheriting the <link linkend='ref-classes-packagegroup'><filename>packagegroup</filename></link> class, setting @@ -10551,7 +10269,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of packages the recipe creates. The default value is the following: <literallayout class='monospaced'> @@ -10592,7 +10309,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes. <filename>PACKAGES_DYNAMIC</filename> @@ -10635,7 +10351,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions run to perform additional splitting of files into individual packages. Recipes can either prepend to this variable or prepend @@ -10657,7 +10372,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extra options passed to the <filename>make</filename> command during the <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> @@ -10714,7 +10428,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extra options passed to the <filename>make install</filename> command during the <link linkend='ref-tasks-install'><filename>do_install</filename></link> @@ -10751,7 +10464,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Determines the action to take when a patch fails. You can set this variable to one of two values: "noop" and "user". @@ -10779,7 +10491,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the utility used to apply patches for a recipe during the <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> @@ -10810,7 +10521,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The epoch of the recipe. By default, this variable is unset. The variable is used to make upgrades possible when the @@ -10832,7 +10542,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the recipe or package name and includes all version and revision numbers (i.e. <filename>glibc-2.13-r20+svnr15508/</filename> and <filename>bash-4.2-r1/</filename>). @@ -10850,7 +10559,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link> class, this variable identifies packages that contain @@ -10871,7 +10579,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The name of the resulting package created by the OpenEmbedded build system. <note> @@ -10895,7 +10602,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The path to <filename>pkg-config</filename> files for the current build context. <filename>pkg-config</filename> reads this variable @@ -10910,7 +10616,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the destination directory for files to be packaged before they are split into individual packages. This directory defaults to the following: @@ -10931,7 +10636,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to a shared, global-state directory that holds data generated during the packaging process. During the packaging process, the @@ -10962,7 +10666,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the parent directory for files to be packaged after they have been split into individual packages. This directory defaults to the following: @@ -10986,7 +10689,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to a temporary work area where the <link linkend='ref-tasks-package'><filename>do_package</filename></link> task saves package metadata. @@ -11015,7 +10717,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The epoch of the package(s) built by the recipe. By default, <filename>PKGE</filename> is set to <link linkend='var-PE'><filename>PE</filename></link>. @@ -11029,7 +10730,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The revision of the package(s) built by the recipe. By default, <filename>PKGR</filename> is set to <link linkend='var-PR'><filename>PR</filename></link>. @@ -11043,7 +10743,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The version of the package(s) built by the recipe. By default, <filename>PKGV</filename> is set to @@ -11054,11 +10753,10 @@ <glossentry id='var-PN'><glossterm>PN</glossterm> <info> - PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. + PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable can have two separate functions depending on the context: a recipe name or a resulting package name. </para> @@ -11095,7 +10793,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists recipes you do not want the OpenEmbedded build system to build. This variable works in conjunction with the @@ -11122,7 +10819,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call once the OpenEmbedded build system has created the host part of the SDK. @@ -11151,7 +10847,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call once the OpenEmbedded build system has created the target part of the SDK. @@ -11180,7 +10875,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The revision of the recipe. The default value for this variable is "r0". Subsequent revisions of the recipe conventionally have the @@ -11236,7 +10930,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If multiple recipes provide the same item, this variable determines which recipe is preferred and thus provides the item (i.e. the preferred provider). @@ -11286,7 +10979,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If multiple versions of recipes exist, this variable determines which version is given preference. You must always suffix the variable with the @@ -11378,7 +11070,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies additional paths from which the OpenEmbedded build system gets source code. When the build system searches for source code, it first @@ -11427,7 +11118,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Indicates the importance of a package. </para> @@ -11453,7 +11143,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver. @@ -11495,29 +11184,40 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of aliases by which a particular recipe can be known. By default, a recipe's own <filename><link linkend='var-PN'>PN</link></filename> is implicitly already in its <filename>PROVIDES</filename> - list. + list and therefore does not need to mention that it provides itself. If a recipe uses <filename>PROVIDES</filename>, the additional aliases are synonyms for the recipe and can - be useful satisfying dependencies of other recipes during + be useful for satisfying dependencies of other recipes during the build as specified by <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. </para> <para> Consider the following example - <filename>PROVIDES</filename> statement from a recipe - file <filename>libav_0.8.11.bb</filename>: + <filename>PROVIDES</filename> statement from the recipe + file <filename>eudev_3.2.9.bb</filename>: <literallayout class='monospaced'> - PROVIDES += "libpostproc" + PROVIDES = "udev" </literallayout> The <filename>PROVIDES</filename> statement results in - the "libav" recipe also being known as "libpostproc". + the "eudev" recipe also being available as simply "udev". + + <note> + Given that a recipe's own recipe name is already + implicitly in its own <filename>PROVIDES</filename> list, + it is unnecessary to add aliases with the "+=" operator; + using a simple assignment will be sufficient. In other + words, while you could write: + <literallayout class='monospaced'> + PROVIDES += "udev" + </literallayout> + in the above, the "+=" is overkill and unnecessary. + </note> </para> <para> @@ -11572,7 +11272,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The network based <link linkend='var-PR'><filename>PR</filename></link> service host and port. @@ -11602,7 +11301,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies whether or not <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink> (ptest) functionality is enabled when building a recipe. @@ -11621,7 +11319,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The version of the recipe. The version is normally extracted from the recipe filename. For example, if the recipe is named @@ -11647,7 +11344,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used by recipes that inherit the <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, @@ -11683,7 +11379,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When used by recipes that inherit the <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, @@ -11719,7 +11414,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run <filename>ranlib</filename>. </para> @@ -11732,7 +11426,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of packages that conflict with packages. Note that packages will not be installed if conflicting packages are not first removed. @@ -11781,7 +11474,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists runtime dependencies of a package. These dependencies are other packages that must be installed in order for the package to function correctly. @@ -11944,7 +11636,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> class, this @@ -11967,7 +11658,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> With <filename>rm_work</filename> enabled, this variable specifies a list of recipes whose work directories should not be removed. @@ -11983,7 +11673,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the root home directory. By default, this directory is set as follows in the BitBake configuration file: @@ -12020,7 +11709,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Indicates a filesystem image to include as the root filesystem. </para> @@ -12040,7 +11728,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call after the OpenEmbedded build system has installed packages. You can specify functions separated by semicolons: @@ -12067,7 +11754,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem. You can specify functions separated by semicolons: @@ -12094,7 +11780,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call after the OpenEmbedded build system has removed unnecessary packages. @@ -12127,7 +11812,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call before the OpenEmbedded build system has created the root filesystem. You can specify functions separated by semicolons: @@ -12154,7 +11838,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target @@ -12183,7 +11866,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of packages that extends the usability of a package being built. The package being built does not depend on this list of @@ -12276,7 +11958,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) @@ -12332,7 +12013,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. @@ -12361,7 +12041,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location in the <link linkend='build-directory'>Build Directory</link> where unpacked recipe source code resides. @@ -12414,7 +12093,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake. @@ -12430,7 +12108,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of the host distribution identifiers that the build system has been tested against. Identifiers consist of the host distributor ID @@ -12455,7 +12132,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The target architecture for the SDK. Typically, you do not directly set this variable. Instead, use @@ -12470,7 +12146,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory set up and used by the <link linkend='ref-classes-populate-sdk'><filename>populate_sdk_base</filename></link> class to which the SDK is deployed. @@ -12489,7 +12164,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The parent directory used by the OpenEmbedded build system when creating SDK output. The @@ -12515,7 +12189,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls whether or not shared state artifacts are copied into the extensible SDK. The default value of "full" copies all of the required @@ -12539,7 +12212,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK. @@ -12572,7 +12244,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK. Including this data allows the @@ -12597,7 +12268,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When set to "1", specifies to include the toolchain in the extensible SDK. Including the toolchain is useful particularly when @@ -12624,7 +12294,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of classes to remove from the <link linkend='var-INHERIT'><filename>INHERIT</filename></link> value globally within the extensible SDK configuration. @@ -12658,7 +12327,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of variables not allowed through from the OpenEmbedded build system configuration into the extensible SDK configuration. @@ -12702,7 +12370,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of variables allowed through from the OpenEmbedded build system configuration into the extensible SDK configuration. @@ -12738,7 +12405,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The base name for SDK output files. The name is derived from the <link linkend='var-DISTRO'><filename>DISTRO</filename></link>, @@ -12761,7 +12427,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the operating system for which the SDK will be built. The default value is the value of @@ -12776,7 +12441,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location used by the OpenEmbedded build system when creating SDK output. The @@ -12806,7 +12470,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not @@ -12826,7 +12489,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of functions to call once the OpenEmbedded build system creates the SDK. You can specify functions separated by semicolons: @@ -12854,7 +12516,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The toolchain binary prefix used for <filename>nativesdk</filename> recipes. The OpenEmbedded build system uses the @@ -12872,7 +12533,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of shared state tasks added to the extensible SDK. By default, the following tasks are added: <literallayout class='monospaced'> @@ -12899,7 +12559,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the system, including the architecture and the operating system, for which the SDK will be built. </para> @@ -12923,7 +12582,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The manifest file for the target part of the SDK. This file lists all the installed packages that make up the target part of the SDK. @@ -12956,7 +12614,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of targets to install from shared state as part of the standard or extensible SDK installation. The default value is "${PN}" (i.e. the image from which @@ -12976,7 +12633,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The title to be printed when running the SDK installer. By default, this title is based on the <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> @@ -13009,7 +12665,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An optional URL for an update server for the extensible SDK. If set, the value is used as the default update server when @@ -13025,7 +12680,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the SDK vendor. </para> </glossdef> @@ -13037,7 +12691,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the version of the SDK. The distribution configuration file (e.g. <filename>/meta-poky/conf/distro/poky.conf</filename>) @@ -13063,7 +12716,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The default installation directory for the Extensible SDK. By default, this directory is based on the <link linkend='var-DISTRO'><filename>DISTRO</filename></link> @@ -13093,7 +12745,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Equivalent to <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. However, this variable applies to the SDK generated from an @@ -13111,7 +12762,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The machine for which the SDK is built. In other words, the SDK is built such that it runs on the target you specify with the @@ -13143,7 +12793,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system. @@ -13161,7 +12810,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default @@ -13176,7 +12824,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The section in which packages should be categorized. Package management utilities can make use of this variable. </para> @@ -13189,7 +12836,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the optimization flags passed to the C compiler when building for the target. The flags are passed through the default value of the @@ -13214,7 +12860,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines a serial console (TTY) to enable using <ulink url='https://en.wikipedia.org/wiki/Getty_(Unix)'>getty</ulink>. Provide a value that specifies the baud rate followed by @@ -13240,7 +12885,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines a serial console (TTY) to enable using <ulink url='https://en.wikipedia.org/wiki/Getty_(Unix)'>getty</ulink>. Provide a value that specifies the baud rate followed by @@ -13259,7 +12903,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies serial consoles, which must be listed in <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>, to check against <filename>/proc/console</filename> @@ -13285,7 +12928,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe. @@ -13337,7 +12979,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of recipes that are completely stable and will never change. The ABI for the recipes in the list are presented by @@ -13361,7 +13002,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the number of bits for the target system CPU. The value should be either "32" or "64". </para> @@ -13374,7 +13014,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the endian byte order of the target system. The value should be either "le" for little-endian or "be" for big-endian. </para> @@ -13383,12 +13022,10 @@ <glossentry id='var-SKIP_FILEDEPS'><glossterm>SKIP_FILEDEPS</glossterm> <info> - SKIP_FILEDEPS[doc] = "Enables you to remove all files from - the "Provides" section of an RPM package." + SKIP_FILEDEPS[doc] = "Enables you to remove all files from the 'Provides' section of an RPM package." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Enables removal of all files from the "Provides" section of an RPM package. Removal of these files is required for packages containing @@ -13415,7 +13052,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common @@ -13437,7 +13073,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the suffix for shared libraries used on the target platform. By default, this suffix is ".so.*" for all Linux-based @@ -13459,7 +13094,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform. By default, this suffix is ".so" for Linux-based @@ -13481,7 +13115,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When you are fetching files to create a mirror of sources (i.e. creating a source mirror), setting <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your @@ -13513,7 +13146,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Defines your own <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> from which to first fetch source before attempting to fetch @@ -13544,7 +13176,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Maps commonly used license names to their SPDX counterparts found in <filename>meta/files/common-licenses/</filename>. For the default <filename>SPDXLICENSEMAP</filename> @@ -13566,7 +13197,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances @@ -13581,7 +13211,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The file type for the Secondary Program Loader (SPL). Some devices use an SPL from which to boot (e.g. the BeagleBone development board). @@ -13623,7 +13252,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The list of source files - local or remote. This variable tells the OpenEmbedded build system which bits to pull in for the build and how to pull them in. @@ -13815,7 +13443,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> By default, the OpenEmbedded build system automatically detects whether <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> contains files that are machine-specific. @@ -13832,7 +13459,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM). </para> @@ -13845,7 +13471,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Returns the version string of the current package. This string is used to help define the value of <link linkend='var-PV'><filename>PV</filename></link>. @@ -13883,7 +13508,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial, and Bazaar only. @@ -13913,7 +13537,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory for the shared state cache. </para> </glossdef> @@ -13925,7 +13548,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set to "1", allows fetches from mirrors that are specified in <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> @@ -13948,7 +13570,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. @@ -13971,7 +13592,7 @@ <para> When pointing to sstate build artifacts on another machine that uses a different GCC version for native builds, - you must configure <filename>SSTATE_MIRROR</filename> + you must configure <filename>SSTATE_MIRRORS</filename> with a regular expression that maps local search paths to server paths. The paths need to take into account @@ -14009,7 +13630,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls the list of files the OpenEmbedded build system scans for hardcoded installation paths. The variable uses a space-separated list of filenames (not paths) with standard @@ -14044,7 +13664,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/lib</filename> subdirectory of the sysroot directory for the build host. @@ -14058,7 +13677,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/lib</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -14073,7 +13691,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/bin</filename> subdirectory of the sysroot directory for the target for which the current @@ -14089,7 +13706,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for @@ -14115,7 +13731,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/bin</filename> subdirectory of the sysroot directory for the build host. @@ -14129,7 +13744,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/share</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -14144,7 +13758,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/share</filename> subdirectory of the sysroot directory for the build host. </para> @@ -14157,7 +13770,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Helps construct the <filename>recipe-sysroots</filename> directory, which is used during packaging. </para> @@ -14196,7 +13808,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the sysroot directory for the system on which the component is built to run (the system that hosts the component). @@ -14267,7 +13878,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the sysroot directory used when building components that run on the build host itself. </para> @@ -14280,7 +13890,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the sysroot used for the system for which the component generates code. For components that do not generate code, which is the @@ -14312,7 +13921,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/etc</filename> subdirectory of the sysroot directory for the build host. @@ -14326,7 +13934,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -14341,7 +13948,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/include</filename> subdirectory of the sysroot directory for the target for which the current @@ -14357,7 +13963,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/include</filename> subdirectory of the sysroot directory for the build host. </para> @@ -14370,7 +13975,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the directory containing the kernel build artifacts. Recipes building software that needs to access kernel @@ -14389,7 +13993,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory with kernel headers that are required to build out-of-tree modules. </para> @@ -14402,7 +14005,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/lib</filename> subdirectory of the sysroot directory for the target for which the current recipe is being built @@ -14417,7 +14019,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the path to the <filename>/usr/lib</filename> subdirectory of the sysroot directory for the build host. </para> @@ -14430,7 +14031,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information. @@ -14467,7 +14067,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the base directory in which the OpenEmbedded build system places stamps. The default directory is @@ -14482,7 +14081,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The minimal command and arguments to run <filename>strip</filename>, which is used to strip symbols. @@ -14496,7 +14094,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The short (72 characters or less) summary of the binary package for packaging systems such as <filename>opkg</filename>, <filename>rpm</filename>, or <filename>dpkg</filename>. @@ -14514,7 +14111,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory in which files checked out of a Subversion system are stored. </para> @@ -14527,7 +14123,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the kernel boot default console. If you want to use a console other than the default, set this variable in your recipe as follows where "X" is @@ -14552,7 +14147,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Lists additional options to add to the syslinux file. You need to set this variable in your recipe. If you want to list multiple options, separate the options @@ -14573,7 +14167,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the alternate serial port or turns it off. To turn off serial, set this variable to an empty string in your recipe. @@ -14597,7 +14190,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An <filename>.LSS</filename> file used as the background for the VGA boot menu when you use the boot menu. You need to set this variable in your recipe. @@ -14618,7 +14210,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the alternate console=tty... kernel boot argument. The variable's default value is set in the <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> @@ -14640,7 +14231,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the temporary directory under the work directory (default "<filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/sysroot-destdir</filename>") @@ -14658,7 +14248,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Directories that are staged into the sysroot by the <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> task. @@ -14682,7 +14271,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Directories that are not staged into the sysroot by the <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> task. @@ -14712,7 +14300,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Extra directories staged into the sysroot by the <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> task for <filename>-native</filename> recipes, in addition @@ -14747,7 +14334,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional @@ -14763,7 +14349,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable specifies whether the specified service @@ -14793,7 +14378,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "systemd-boot", the @@ -14821,7 +14405,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "systemd-boot", the @@ -14851,7 +14434,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> is set to "systemd-boot", the @@ -14879,7 +14461,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable locates the systemd unit files when @@ -14909,7 +14490,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-systemd'><filename>systemd</filename></link> class, this variable specifies the systemd service name for @@ -14934,7 +14514,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When using <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, specifies a space-separated list of the virtual terminals @@ -14963,7 +14542,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe. @@ -14992,7 +14570,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The target machine's architecture. The OpenEmbedded build system supports many architectures. @@ -15025,7 +14602,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific assembler flags for the target system. <filename>TARGET_AS_ARCH</filename> is initialized from @@ -15045,7 +14621,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific C compiler flags for the target system. <filename>TARGET_CC_ARCH</filename> is initialized from @@ -15069,7 +14644,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune. The flag is used rarely and only for cases where a @@ -15094,7 +14668,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C compiler when building for the target. When building in the target context, @@ -15118,7 +14691,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target. @@ -15143,7 +14715,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the C++ compiler when building for the target. When building in the target context, @@ -15167,7 +14738,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to "soft". @@ -15182,7 +14752,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific linker flags for the target system. <filename>TARGET_LD_ARCH</filename> is initialized from @@ -15202,7 +14771,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the flags to pass to the linker when building for the target. When building in the target context, @@ -15228,7 +14796,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the target's operating system. The variable can be set to "linux" for glibc-based systems (GNU C Library) and to "linux-musl" for musl libc. @@ -15244,7 +14811,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the prefix used for the toolchain binary target tools. </para> @@ -15280,7 +14846,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the system, including the architecture and the operating system, for which the build is occurring in the context of the current recipe. @@ -15323,7 +14888,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the name of the target vendor. </para> </glossdef> @@ -15331,11 +14895,10 @@ <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> <info> - TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc', 'musl' or "newlib." + TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc', 'musl' or 'newlib'." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the GNU standard C library (<filename>libc</filename>) variant to use during the build process. @@ -15355,7 +14918,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a suffix to be appended onto the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> value. @@ -15386,7 +14948,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the toolchain selector. <filename>TCMODE</filename> controls the characteristics of the generated packages and images by telling the @@ -15458,7 +15019,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The location the OpenEmbedded build system uses to export tests when the <link linkend='var-TEST_EXPORT_ONLY'><filename>TEST_EXPORT_ONLY</filename></link> @@ -15478,7 +15038,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that @@ -15493,7 +15052,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to <filename>"${WORKDIR}/testimage"</filename>. @@ -15512,7 +15070,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For automated hardware testing, specifies the command to use to control the power of the target machine under test. Typically, this command would point to a script that @@ -15532,7 +15089,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For automated hardware testing, specifies additional arguments to pass through to the command specified in <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>. @@ -15551,7 +15107,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image. @@ -15575,7 +15130,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test. @@ -15601,7 +15155,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For automated hardware testing, specifies additional arguments to pass through to the command specified in <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>. @@ -15620,7 +15173,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The IP address of the build machine (host machine). This IP address is usually automatically detected. However, if detection fails, this variable needs to be set @@ -15643,12 +15195,11 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the target controller to use when running tests against a test image. - The default controller to use is "QemuTarget": + The default controller to use is "qemu": <literallayout class='monospaced'> - TEST_TARGET = "QemuTarget" + TEST_TARGET = "qemu" </literallayout> </para> @@ -15667,21 +15218,21 @@ You can provide the following arguments with <filename>TEST_TARGET</filename>: <itemizedlist> - <listitem><para><emphasis>"QemuTarget":</emphasis> + <listitem><para><emphasis>"qemu":</emphasis> Boots a QEMU image and runs the tests. See the "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" section in the Yocto Project Development Tasks Manual for more information. </para></listitem> - <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> + <listitem><para><emphasis>"simpleremote":</emphasis> Runs the tests on target hardware that is already up and running. The hardware can be on the network or it can be a device running an image on QEMU. You must also set <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> - when you use "SimpleRemoteTarget". + when you use "simpleremote". <note> This argument is defined in <filename>meta/lib/oeqa/controllers/simpleremote.py</filename>. @@ -15704,7 +15255,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The IP address of your hardware under test. The <filename>TEST_TARGET_IP</filename> variable has no effect when @@ -15734,7 +15284,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An ordered list of tests (modules) to run against an image when performing automated runtime testing. </para> @@ -15793,7 +15342,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Automatically runs the series of automated tests for images when an image is successfully built. Setting <filename>TESTIMAGE_AUTO</filename> to "1" @@ -15834,7 +15382,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The directory in which the file BitBake is currently parsing is located. Do not manually set this variable. @@ -15848,7 +15395,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The time the build was started. Times appear using the hour, minute, and second (HMS) format (e.g. "140159" for one minute and fifty-nine @@ -15863,7 +15409,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable is the base directory the OpenEmbedded build system uses for all build output and intermediate files (other than the shared state cache). @@ -15905,7 +15450,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment. @@ -15947,7 +15491,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable defines the name used for the toolchain output. The @@ -15973,7 +15516,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK (i.e. the part built for the target hardware), which @@ -16006,7 +15548,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The top-level <link linkend='build-directory'>Build Directory</link>. BitBake automatically sets this variable when you @@ -16022,7 +15563,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A sanitized version of <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. This variable is used where the architecture is needed in @@ -16044,7 +15584,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The GNU canonical architecture for a specific architecture (i.e. <filename>arm</filename>, <filename>armeb</filename>, @@ -16103,7 +15642,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific assembler flags for the target system. The set of flags is based on the selected tune features. @@ -16134,7 +15672,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific C compiler flags for the target system. The set of flags is based on the selected tune features. @@ -16159,7 +15696,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies architecture-specific linker flags for the target system. The set of flags is based on the selected tune features. @@ -16190,7 +15726,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Features used to "tune" a compiler for optimal use given a specific processor. The features are defined within the tune files and allow @@ -16224,7 +15759,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages. @@ -16255,7 +15789,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> An underlying Application Binary Interface (ABI) used by a particular tuning in a given toolchain layer. Providers that use prebuilt libraries can use the @@ -16283,7 +15816,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> If set, the OpenEmbedded system ignores the <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> variable. @@ -16310,7 +15842,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A whitelist of permissible <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> values. @@ -16338,7 +15869,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with <replaceable>feature</replaceable>. </para> @@ -16364,7 +15894,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a valid CPU or Application Binary Interface (ABI) tuning feature. The specified feature is stored as a flag. @@ -16394,7 +15923,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Configures the <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> and can also define @@ -16437,7 +15965,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the entry point for the U-Boot image. During U-Boot image creation, the <filename>UBOOT_ENTRYPOINT</filename> variable is passed @@ -16453,7 +15980,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the load address for the U-Boot image. During U-Boot image creation, the <filename>UBOOT_LOADADDRESS</filename> variable is passed @@ -16469,11 +15995,10 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Appends a string to the name of the local version of the U-Boot image. For example, assuming the version of the U-Boot image - built was "2013.10, the full version string reported by + built was "2013.10", the full version string reported by U-Boot would be "2013.10-yocto" given the following statement: <literallayout class='monospaced'> @@ -16489,7 +16014,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the value passed on the <filename>make</filename> command line when building a U-Boot image. @@ -16513,7 +16037,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the target called in the <filename>Makefile</filename>. The default target is "all". @@ -16527,7 +16050,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Points to the generated U-Boot extension. For example, <filename>u-boot.sb</filename> has a <filename>.sb</filename> extension. @@ -16546,7 +16068,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the target used for building U-Boot. The target is passed directly as part of the "make" command (e.g. SPL and AIS). @@ -16563,7 +16084,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the @@ -16601,7 +16121,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> For recipes inheriting the <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> class, <filename>UPDATERCPN</filename> specifies @@ -16624,7 +16143,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> You can perform a per-recipe check for what the latest upstream source code version is by calling <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. @@ -16653,7 +16171,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Use the <filename>UPSTREAM_CHECK_REGEX</filename> variable to specify a different regular expression instead of the default one when the package checking system is parsing @@ -16672,7 +16189,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> You can perform a per-recipe check for what the latest upstream source code version is by calling <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. @@ -16696,7 +16212,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Determines if <filename>devtmpfs</filename> is used for <filename>/dev</filename> population. The default value used for <filename>USE_DEVFS</filename> @@ -16721,7 +16236,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When using <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, determines whether or not to run a @@ -16747,7 +16261,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> A list of classes to globally inherit. These classes are used by the OpenEmbedded build system to enable extra features (e.g. @@ -16771,18 +16284,20 @@ <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm> <info> - USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files. If set to 'warn', a warning will be issued instead." + USERADD_ERROR_DYNAMIC[doc] = "If set to 'error', forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in any of the files listed in USERADD_UID_TABLES and USERADD_GID_TABLES. If set to 'warn', a warning will be issued instead." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "error", forces the OpenEmbedded build system to - produce an error if the user identification - (<filename>uid</filename>) and group identification - (<filename>gid</filename>) values are not defined - in <filename>files/passwd</filename> - and <filename>files/group</filename> files. - If set to "warn", a warning will be issued instead. + + If set to <filename>error</filename>, forces the + OpenEmbedded build system to produce an error if the user + identification (<filename>uid</filename>) and group + identification (<filename>gid</filename>) values are not + defined in any of the files listed + in <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link> + and <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>. If + set to <filename>warn</filename>, a warning will be issued + instead. </para> <para> @@ -16809,6 +16324,20 @@ <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> variables. </para> + + <note> + There is a difference in behavior between + setting <filename>USERADD_ERROR_DYNAMIC</filename> + to <filename>error</filename> and setting it + to <filename>warn</filename>. When it is set + to <filename>warn</filename>, the build system will report a + warning for every undefined <filename>uid</filename> and + <filename>gid</filename> in any recipe. But when it is set + to <filename>error</filename>, it will only report errors + for recipes that are actually built. This saves you from + having to add static IDs for recipes that you know will + never be built. + </note> </glossdef> </glossentry> @@ -16818,7 +16347,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a password file to use for obtaining static group identification (<filename>gid</filename>) values when the OpenEmbedded build system adds a group to the @@ -16854,7 +16382,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -16891,7 +16418,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When inheriting the <link linkend='ref-classes-useradd'><filename>useradd</filename></link> class, this variable @@ -16922,7 +16448,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies a password file to use for obtaining static user identification (<filename>uid</filename>) values when the OpenEmbedded build system adds a user to the @@ -16958,7 +16483,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static @@ -17011,7 +16535,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the persistence of the target's <filename>/var/log</filename> directory, which is used to house postinstall target log files. @@ -17036,7 +16559,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system. You set this variable in your distribution configuration @@ -17108,7 +16630,7 @@ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" section in the Yocto Project Development Tasks Manual. For details on the kickstart file format, see the - "<link linkend='ref-kickstart'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link> + "<link linkend='ref-kickstart'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link>" Chapter. </para> </glossdef> @@ -17120,7 +16642,6 @@ </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> The pathname of the work directory in which the OpenEmbedded build system builds a recipe. This directory is located within the @@ -17178,12 +16699,10 @@ <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm> <info> - XSERVER[doc] = "Specifies the packages that should be installed - to provide an X server and drivers for the current machine." + XSERVER[doc] = "Specifies the packages that should be installed to provide an X server and drivers for the current machine." </info> <glossdef> <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Specifies the packages that should be installed to provide an X server and drivers for the current machine, assuming your image directly includes diff --git a/poky/documentation/sdk-manual/sdk-appendix-obtain.xml b/poky/documentation/sdk-manual/sdk-appendix-obtain.xml index 765c0f218..86b6d7dd0 100644 --- a/poky/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/poky/documentation/sdk-manual/sdk-appendix-obtain.xml @@ -297,8 +297,7 @@ <replaceable>arch</replaceable> is a string representing the target architecture: beaglebone-yocto, beaglebone-yocto-lsb, edgerouter, edgerouter-lsb, - genericx86, genericx86-64, genericx86-64-lsb, genericx86-lsb, - mpc8315e-rdb, mpc8315e-rdb-lsb, and qemu*. + genericx86, genericx86-64, genericx86-64-lsb, genericx86-lsb and qemu*. <!--> <replaceable>date_time</replaceable> is a date and time stamp. diff --git a/poky/documentation/sdk-manual/sdk-manual.xml b/poky/documentation/sdk-manual/sdk-manual.xml index 8d5f6ec4d..537663dad 100644..100755 --- a/poky/documentation/sdk-manual/sdk-manual.xml +++ b/poky/documentation/sdk-manual/sdk-manual.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>srifenbark@gmail.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -34,7 +33,7 @@ <revision> <revnumber>2.1</revnumber> <date>April 2016</date> - <revremark>Released with the Yocto Project 2.1 Release.</revremark> + <revremark>The initial document released with the Yocto Project 2.1 Release.</revremark> </revision> <revision> <revnumber>2.2</revnumber> @@ -68,9 +67,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -92,7 +96,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -109,18 +113,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> </legalnotice> diff --git a/poky/documentation/toaster-manual/toaster-manual.xml b/poky/documentation/toaster-manual/toaster-manual.xml index d7b4bcee6..e6d424523 100644..100755 --- a/poky/documentation/toaster-manual/toaster-manual.xml +++ b/poky/documentation/toaster-manual/toaster-manual.xml @@ -22,11 +22,10 @@ <authorgroup> <author> - <firstname>Kristi</firstname> <surname>Rifenbark</surname> <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> + <orgname>&ORGNAME;</orgname> </affiliation> - <email>kristi@buzzcollectivemarketing.com</email> + <email>&ORGEMAIL;</email> </author> </authorgroup> @@ -34,7 +33,7 @@ <revision> <revnumber>1.8</revnumber> <date>April 2015</date> - <revremark>Released with the Yocto Project 1.8 Release.</revremark> + <revremark>The initial document released with the Yocto Project 1.8 Release.</revremark> </revision> <revision> <revnumber>2.0</revnumber> @@ -78,9 +77,14 @@ </revision> <revision> <revnumber>3.0</revnumber> - <date>&REL_MONTH_YEAR;</date> + <date>October 2019</date> <revremark>Released with the Yocto Project 3.0 Release.</revremark> </revision> + <revision> + <revnumber>3.1</revnumber> + <date>&REL_MONTH_YEAR;</date> + <revremark>Released with the Yocto Project 3.1 Release.</revremark> + </revision> </revhistory> <copyright> @@ -102,7 +106,7 @@ Yocto Project. To be sure you have the latest version of the manual for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -119,18 +123,20 @@ page. If you need a version of this manual for a different Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> + <ulink url='&YOCTO_DOCS_URL;'>Yocto Project documentation page</ulink> and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. </para></listitem> - <listitem><para> + <listitem> + <para> To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> + (or any other Yocto Project) manual, send an email to + the Yocto Project documentation mailing list at + <filename>docs@lists.yoctoproject.org</filename> or + log into the freenode <filename>#yocto</filename> channel. + </para> + </listitem> </itemizedlist> </note> diff --git a/poky/documentation/tools/mega-manual.sed b/poky/documentation/tools/mega-manual.sed index 374d8e7b0..b1ea9edb7 100644 --- a/poky/documentation/tools/mega-manual.sed +++ b/poky/documentation/tools/mega-manual.sed @@ -1,36 +1,36 @@ # Processes bitbake-user-manual (<word>-<word>-<word> style). # This style is for manual three-word folders, which currently is only the BitBake User Manual. # We used to have the "yocto-project-qs" and "poky-ref-manual" folders but no longer do. -# s@"ulink" href="http://www.yoctoproject.org/docs/3.0/[a-z]*-[a-z]*-[a-z]*/[a-z]*-[a-z]*-[a-z]*.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g +# s@"ulink" href="http://www.yoctoproject.org/docs/3.1/[a-z]*-[a-z]*-[a-z]*/[a-z]*-[a-z]*-[a-z]*.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g # Processes all other manuals (<word>-<word> style). # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual"). # Here is the one-liner: -# s@"ulink" href="http://www.yoctoproject.org/docs/3.0/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g +# s@"ulink" href="http://www.yoctoproject.org/docs/3.1/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/sdk-manual/sdk-manual.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/bsp-guide/bsp-guide.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/dev-manual/dev-manual.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/overview-manual/overview-manual.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/brief-yoctoprojectqs/brief-yoctoprojectqs.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/kernel-dev/kernel-dev.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/profile-manual/profile-manual.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/ref-manual/ref-manual.html#@"link" href="#@g -s@"ulink" href="http://www.yoctoproject.org/docs/3.0/toaster-manual/toaster-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/sdk-manual/sdk-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/bsp-guide/bsp-guide.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/dev-manual/dev-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/overview-manual/overview-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/brief-yoctoprojectqs/brief-yoctoprojectqs.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/kernel-dev/kernel-dev.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/profile-manual/profile-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/ref-manual/ref-manual.html#@"link" href="#@g +s@"ulink" href="http://www.yoctoproject.org/docs/3.1/toaster-manual/toaster-manual.html#@"link" href="#@g # Process cases where just an external manual is referenced without an id anchor -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/brief-yoctoprojectqs/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build</a>@Yocto Project Quick Build@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/bitbake-user-manual/bitbake-user-manual.html" target="_top">BitBake User Manual</a>@BitBake User Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>@Yocto Project Development Tasks Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/overview-manual/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual</a>@Yocto project Overview and Concepts Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/sdk-manual/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a>@Yocto Project Application Development and the Extensible Software Development Kit (eSDK)@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/bsp-guide/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide</a>@Yocto Project Board Support Package (BSP) Developer's Guide@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/profile-manual/profile-manual.html" target="_top">Yocto Project Profiling and Tracing Manual</a>@Yocto Project Profiling and Tracing Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/kernel-dev/kernel-dev.html" target="_top">Yocto Project Linux Kernel Development Manual</a>@Yocto Project Linux Kernel Development Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>@Yocto Project Reference Manual@g -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/toaster-manual/toaster-manual.html" target="_top">Toaster User Manual</a>@Toaster User Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/brief-yoctoprojectqs/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build</a>@Yocto Project Quick Build@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/bitbake-user-manual/bitbake-user-manual.html" target="_top">BitBake User Manual</a>@BitBake User Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>@Yocto Project Development Tasks Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/overview-manual/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual</a>@Yocto project Overview and Concepts Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/sdk-manual/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a>@Yocto Project Application Development and the Extensible Software Development Kit (eSDK)@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/bsp-guide/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide</a>@Yocto Project Board Support Package (BSP) Developer's Guide@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/profile-manual/profile-manual.html" target="_top">Yocto Project Profiling and Tracing Manual</a>@Yocto Project Profiling and Tracing Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/kernel-dev/kernel-dev.html" target="_top">Yocto Project Linux Kernel Development Manual</a>@Yocto Project Linux Kernel Development Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>@Yocto Project Reference Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/toaster-manual/toaster-manual.html" target="_top">Toaster User Manual</a>@Toaster User Manual@g # Process a single, rouge occurrence of a linked reference to the Mega-Manual. -s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.0/mega-manual/mega-manual.html" target="_top">Yocto Project Mega-Manual</a>@Yocto Project Mega-Manual@g +s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/mega-manual/mega-manual.html" target="_top">Yocto Project Mega-Manual</a>@Yocto Project Mega-Manual@g |