summaryrefslogtreecommitdiff
path: root/poky/documentation/ref-manual
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2021-09-25 00:47:35 +0300
committerAndrew Geissler <geissonator@yahoo.com>2021-10-05 22:27:21 +0300
commit5199d831602da71945df7cef62eb3c01183cf20e (patch)
tree0e4c75d4ac0f346489cb92fa4ccccf0a0aa56fe1 /poky/documentation/ref-manual
parente9e982486160a1d724bf30f21167d72dfbcb84ce (diff)
downloadopenbmc-5199d831602da71945df7cef62eb3c01183cf20e.tar.xz
subtree updates
meta-security: 1f18c623e9..de6712a806: Armin Kuster (8): cryfs: drop recipe trousers: set precise BSD license ibmtpm2tss: set precise BSD license ibmswtpm2: set precise BSD license opendnssec: set precise BSD license checksec: set precise BSD license isic: set precise BSD license tpm-quote-tools: Update SRC_URI Christer Fletcher (1): dm-verity-img.bbclass: Expose --data-block-size for configuration Kai Kang (1): sssd: 2.5.1 -> 2.5.2 meta-raspberrypi: a6fa6b3aec..9eb4879cf4: Andrew Penner (1): rpi-cmdline: Support ethernet over USB Khem Raj (2): linux-raspberrypi: Update to 5.10.63 raspberrypi-firmware: Update to latest meta-openembedded: e4a3c66505..cff8331f96: Armin Kuster (21): python3-cycler: set precise BSD license python3-dill: set precise BSD license python3-ipython-genutils: set precise BSD license python3-traitlets: set precise BSD license python3-parallax: set precise BSD license python3-ipython:set precise BSD license python3-mpmath: set precise BSD license python3-sympy: set precise BSD license python3-sqlparse: set precise BSD license python3-webencodings: set precise BSD license python3-pyperclip:set precise BSD license python3-geojson: set precise BSD license python3-aenum: set precise BSD license python3-gnupg: set precise BSD license python3-kiwisolver: set precise BSD license python3-jdcal: set precise BSD license python3-send2trash: set precise BSD license python3-flask-bootstrap: Update LICENSES autossh: set precise BSD licenses jemalloc: set precise BSD license gpsd-machine-conf: set precise BSD license Bruce Ashfield (1): vboxguestdrivers: fix build against 5.14+ Ed Tanous (1): Boost-url Move to latest version Khem Raj (57): gdm: Add polkit to required distro features python3-lxml: Inherit pkgconfig python3-icu: Inherit pkgconfig python3-h5py: Inherit pkgconfig python3-pyparted: Inherit pkgconfig python3-systemd: Inherit pkgconfig rp-pppoe: Add configure cached variable via recipe site: Remove local site files postfix: Inherit pkgconfig emacs: Inherit pkgconfig libgnt: Inherit pkgconfig libgnt: Inherit pkgconfig portaudio-v19: Inherit pkgconfig sshfs-fuse: Inherit pkgconfig appstream-glib: Inherit pkgconfig volume-key: Inherit pkgconfig kronosnet: Inherit pkgconfig rrdtool: Inherit pkgconfig libbytesize: Inherit pkgconfig dlt-daemon: Inherit pkgconfig libmypaint: Inherit pkgconfig libubox: Inherit pkgconfig xfsprogs: Inherit pkgconfig pavucontrol: Inherit pkgconfig blueman: Inherit pkgconfig mimic: Inherit pkgconfig libchamplain: Inherit pkgconfig gst-shark: Inherit pkgconfig zchunk: Inherit pkgconfig libvdpau: Inherit pkgconfig tigervnc: Inherit pkgconfig mpc: Inherit pkgconfig avro-c: Inherit pkgconfig udevil: Inherit pkgconfig remmina: Inherit pkgconfig transmission: Inherit pkgconfig libuvc: Inherit pkgconfig crda: Inherit pkgconfig wxwidgets: Inherit pkgconfig mdbus2: Inherit pkgconfig firewalld: Inherit pkgconfig renderdoc: Inherit pkgconfig fetchmail: Inherit pkgconfig ncmpc: Inherit pkgconfig yad: Inherit pkgconfig mscgen: Inherit pkgconfig libldb: Inherit pkgconfig pahole: Inherit missing pkgconfig gerbera: Inherit pkgconfig xfce4-datetime-setter: Inherit pkgconfig libblockdev: Inherit pkgconfig ntopng: Inherit pkgconfig mosquitto: Inherit pkgconfig samba: Inherit pkgconfig fio: Upgrade to 3.28 rdma-core: Inherit pkgconfig postfix: Add missing dependency on m4 Marek Vasut (1): dstat: Add missing python-six runtime dependency Matteo Croce (1): pahole: call python via env in the shebang Pascal Bach (1): poco: update to 1.11.0 Peter Kjellerstedt (1): libiio: Make libiio-python3 depend on python3-core Pierre-Jean Texier (1): cppzmq: upgrade 4.8.0 -> 4.8.1 Sakib Sajal (3): bats: source files from correct directory gd: upgrade 2.3.2 -> 2.3.3 lmdb: replace tag with commit id in SRCREV Trevor Woerner (2): vk-gl-cts: allow the user to specify the target vk-gl-cts: fix soname linking Yi Zhao (2): samba: upgrade 4.14.5 -> 4.14.7 net-snmp: remove perllocal.pod when enable packageconfig[perl] jan (1): netdata: Fixed the recipe. wangmy (3): byacc: upgrade 20200910 -> 20210808 nghttp2: upgrade 1.44.0 -> 1.45.1 apache2: upgrade 2.4.48 -> 2.4.49 zangrc (5): python3-beautifulsoup4: upgrade 4.9.3 -> 4.10.0 python3-bitarray: upgrade 2.3.3 -> 2.3.4 python3-decorator: upgrade 5.0.9 -> 5.1.0 python3-grpcio-tools: upgrade 1.39.0 -> 1.40.0 python3-grpcio: upgrade 1.39.0 -> 1.40.0 zhengruoqin (5): python3-openpyxl: upgrade 3.0.7 -> 3.0.8 python3-pandas: upgrade 1.3.2 -> 1.3.3 python3-pulsectl: upgrade 21.5.18 -> 21.9.1 protobuf: upgrade 3.17.3 -> 3.18.0 span-lite: upgrade 0.10.0 -> 0.10.1 poky: 359e1cb62f..06dcace68b: Alexander Kanavin (13): lttng: update 2.12 -> 2.13.0 core-image-ptest-all: bump RAM requirement to 4G bitbake: bitbake: drop old rules for python warnings bitbake: bitbake: correct the collections vs collections.abc deprecation bitbake: bitbake: fix regexp deprecation warnings bitbake: bitbake: do not import imp in layerindexlib bitbake: bitbake: adjust parser error check for python 3.10 compatibility bitbake: bitbake: correct deprecation warning in process.py bitbake: bitbake: enable python warnings at the first opportunity meta: correct collections vs collections.abc deprecation wic: keep rootfs_size as integer cpan-base.bbclass: use raw string for regexp testimage: symlink the task log and qemu console log to tmp/log/oeqa Armin Kuster (2): apr: Security fix for CVE-2021-35940 tar: ignore node-tar CVEs Bruce Ashfield (11): linux-yocto/5.13: update to v5.13.13 linux-yocto/5.13: update to v5.13.15 linux-yocto/5.10: update to v5.10.61 linux-yocto/5.10: update to v5.10.63 yocto-bsp/5.10: update to v5.10.63 yocto-bsp/5.13: update to v5.13.15 libc-headers: bump to v5.14 linux-yocto: introduce 5.14 reference kernel systemtap: update to 4.5-latest conf/machine: bump qemu preferred versions to 5.14 poky: set default kernel to 5.14 Changqing Li (1): lttng-ust: fix do_compile error when PACKAGECONFIG examples is enabled Chanho Park (1): binutils: inherit pkgconfig to address libdebuginfod depdency Claudius Heine (1): rng-tools: add systemd-udev-settle wants to service Daniel Ammann (1): bitbake: fetch2/wget: Enable ftps Daniel Wagenknecht (2): mirrors.bbclass: provide additional rule for git repo fallbacks mirrors.bbclass: remove redundant server-specific mirrors Denys Dmytriyenko (1): readline: correct pkg-config dependency for termcap Hsia-Jun(Randy) Li (1): cross-canadian: make android pass target sys check Jon Mason (6): Update mailing list address README: update mailing list address dev-manual: update mailing list address core-image-sato: Fix runqemu error for qemuarmv5 machine/qemuarm*: use virtio graphics testimage: remove aarch64 xorg exclusion Joshua Watt (17): Add SPDX licenses classes/package: Add extended packaged data classes/create-spdx: Add class classes/create-spdx: Change creator classes/create-spdx: Add SHA1 to index file classes/create-spdx: Add index to DEPLOYDIR classes/create-spdx: Add runtime dependency mapping classes/create-spdx: Add NOASSERTION for unknown debug sources classes/create-spdx: Fix another creator classes/create-spdx: Fix up license reporting classes/create-spdx: Speed up hash calculations classes/create-spdx: Fix file:// in downloadLocation classes/create-spdx: Add special exception for Public Domain license classes/create-spdx: Collect all task dependencies classes/create-spdx: Skip package processing for native recipes classes/create-spdx: Comment out placeholder license warning bitbake: cooker: Allow upstream for local hash equivalence server Kai Kang (2): perl: fix CVE-2021-36770 rust-common.bbclass: make sure ccache exist Kevin Hao (1): meta-yocto-bsp: Update the default kernel to v5.14 Khem Raj (3): vim: Add packageconfig for sound notification support site: Drop caching libIDL_cv_long_long_format site: Drop ORBit2 relared cached variables Konrad Weihmann (1): expat: pull from github releases Kristian Klausen (3): systemd: Add homed PACKAGECONFIG wic: Add extra-space argument systemd: Add tpm2 PACKAGECONFIG Mark Hatle (3): reproducible_build: Remove BUILD_REPRODUCIBLE_BINARIES checking externalsrc: Work with reproducible_build tcf-agent: Move to the latest master version Markus Volk (1): util-linux: disable raw Martin Jansa (3): default-distrovars.inc: Set BBINCLUDELOGS to empty to disable printing failed task output multiple times bitbake: bitbake.conf: fix vars_from_file() call qemu-native: add direct dependency on ninja-native and meson-native Michael Halstead (1): releases: update to include 3.3.3 Michael Opdenacker (9): dev-manual: explicit that devpyshell is a task bitbake: bitbake-user-manual: replace "file name" by "filename" manuals: replace Freenode by Libera Chat as IRC host manuals: delete unmaintained history sections ref-manual: document UPSTREAM_CHECK_COMMITS and UPSTREAM_VERSION_UNKNOWN ref-manual: remove checkpkg task ref-manual: improve "devtool check-upgrade-status" details ref-manual: improve documentation for RECIPE_NO_UPDATE_REASON ref-manual: update "devtool check-upgrade-status" output Mingli Yu (6): coreutils: add pkgconfig for selinux findutils: add pkgconfig for selinux tar: add pkgconfig for selinux multilib.bbclass: add RDEPENDS related check back insane.bbclass: add FILERDEPENDS related check back python3: fix multilib qa issue Peter Bergin (1): systemd: add packageconfig for wheel-group Peter Kjellerstedt (2): common-licenses, licenses.conf: Remove duplicate licenses create-spdx.bbclass: Search all license directories for licenses Quentin Schulz (3): bitbake: doc: bitbake-user-manual-execution: remove mention to long-gone BBHASHDEPS variable conf/mips: mips16e: prepend override to MACHINEOVERRIDES bitbake: doc: bitbake-user-manual-fetching: S should be set to WORKDIR/git for git fetcher Randy MacLeod (1): tcmode-default: add rust to the default toolchains Ranjitsinh Rathod (1): rpm: Handle proper return value to avoid major issues Richard Purdie (67): oeqa/runtime/parselogs: Make DVD ata error apply to all qemux86 machines tcl: Exclude CVE-2021-35331 from checks xdg-utils: Add fix for CVE-2020-27748 build-appliance-image: Update to master head revision utils: Drop unused variable staging_install from oe_libinstall utils: Drop obsolete oe_machinstall function flex: Add CVE-2019-6293 to exclusions for checks go: Exclude CVE-2021-29923 from report list bitbake: runqueue: Avoid deadlock avoidance task graph corruption bitbake: runqueue: Fix issues with multiconfig deferred task deadlock messages oeqa/oescripts: Fix after tar recipe changes pseudo: Update with fcntl and glibc 2.34 fixes bitbake: persist_data: Drop deprecated/unused function bitbake: parse_py: Drop deprecated function reference bitbake: build: Match markup to real function name bitbake: build: Handle SystemExit in python tasks correctly bitbake: process: Don't include logs in error message if piping them bitbake: build: Avoid duplicating logs in verbose mode bitbake: data_smart: Make ExpansionErrors more readable bitbake: build: Catch and error upon circular task references bitbake: data_smart: Improve error display for handled exceptions bitbake: fetch2: Add recursion guard bitbake: cookerdata: Improve missing core layer error message bitbake: cookerdata: Show error for no BBLAYERS in bblayers.conf bitbake: runqueue: Clean up task stats handling Revert "default-distrovars.inc: Set BBINCLUDELOGS to empty to disable printing failed task output multiple times" bitbake.conf: Ensure XZ_THREADS doesn't change sstate checksums sstate: Avoid problems with recipes using SRCPV when fetching sstate local.conf.sample: Update sstate mirror entry with new hash equivalence setting useradd: Ensure preinst data is expanded correctly in pkgdata package: Fix pkgdata determinism issues sstate: Ensure SDE is accounted for in package task timestamps bash: Ensure deterministic build sstatesig: Allow exclusion of the root directory for do_package bitbake: bitbake-worker: Improve error handling bitbake: runqueue/knotty: Improve UI handling of setscene task counting bitbake: fetch2/git: Avoid races over mirror tarball creation README: Update email address for Bruce bitbake: cookerdata: Show a readable error for invalid multiconfig name bitbake: fetch2/git: Use os.rename instead of mv bitbake: tests/fetch2: Fix quoting warning bitbake: data_smart: Don't add None to ExpansionError varlist bitbake: fetch2/svn: Allow peg-revision functionality to be disabled vim: Backport fix for CVE-2021-3770 libgcrypt: Upgrade 1.9.3 -> 1.9.4 sqlite3: Exclude CVE-2021-36690 from cve checks recipes: Add missing pkgconfig inherit lttng-tools: Add missing DEPENDS on bison-native cross: Drop unused do_install pybootchart: Avoid divide by zero bitbake: tests/fetch2: Use our own git server for dtc test repo scripts/oe-publish-sdk: Disable git gc to avoid build errors image/qemu: Add explict depends for qemu-helper addto_recipe_sysroot task siteinfo/autotools: Ensure task checksums reflect site files package_ipk/deb/rpm: Drop recursive do_build task dependencies reproducible_build/package_XXX: Ensure SDE task is in dependency chain populate_sdk_base/images: Drop use of 'meta' class and hence do_build dependencies buildtools-tarball/uninative-tarball/meta-ide-support: Drop useless meta class meta: Drop useless class staging: Mark deploy an sstate task sstate: Ensure deploy tasks don't pull in toolchains sstate: Avoid deploy_source_date_epoch sstate when unneeded ssate: Cleanup directtasks handling bitbake: build: Ensure python stdout/stderr is logged correctly bitbake: build: Make exception printing clearer bitbake: build: Fix log flushing race oeqa/selftest: Add tests for bitbake shell/python task output Robert P. J. Day (16): dev-manual: pass False to d.getVar() for devpyshell example ref-manual: add missing "${PN}-src" to default PACKAGES list dev-manual: small number of minor aesthetic tweaks dev-manual: various pedantic nitpickery dev-manual: drop "three" since there are four requirements ref-manual: update SYSROOT_DIRS_* variable entries README: update manual list and names, online docs URL image_types_wic.bbclass: alphabetize list of WICVARS systemd: '${systemd_unitdir}/system' => '${systemd_system_unitdir}' ref-manual: render options in monospace to show quotes properly ref-manual: remove mention of obsolete devtool "--any-recipe" option ref-manual: correct typo in "classes" section, "${BPN}/{PV}" ref-manual: add potential of parallelism to defn of "Task" ref-manual: couple minor tweaks to Chapter 1 dev-manual: emphasize that new layers live outside of poky dev-manual: update output of "wic list images" Robert Yang (1): assimp: Remove it Ross Burton (40): lz4: remove redundant BSD license python3-numpy: remove redundant BSD license quota: remove BSD license nfs-utils: set precise BSD license dtc: set precise BSD license acpica: set precise BSD license libevent: set precise BSD license openssh: remove redundant BSD license python3-packaging: fix license statement iputils: set precise BSD license libx11-compose-data: set precise BSD license webkitgtk: set precise BSD license libwpe: set precise BSD license wpebackend-fdo: set precise BSD license common-licenses: add missing SPDX licences dev-manual/common-tasks: sync libxpm fragment with the recipe lsof: correct LICENSE selftest/python-async-test: set precise BSD license lsof: add upstream check xinetd: correct LICENSE oeqa/recipeutils: update for license change to python-async-test libxfont: set precise BSD license valgrind: set precise BSD license shadow-sysroot: sync license with shadow ovmf: set precise BSD license ppp: set precise BSD license ffmpeg: update LICENSE hdparm: set correct license recipetool/create_buildsys_python: treat BSD as BSD-3-Clause oeqa/selftest/recipetool: update for license changes create-spdx: transform license list into a dict for faster lookups create-spdx: remove redundant test create-spdx: embed unknown license texts create-spdx: don't duplicate license texts in each package create-spdx: handle CLOSED license ffmpeg: fix LICENSE avahi: remove obsolete intltool-native dependency shared-mime-info: use a more concise description libsoup-2.4: remove obsolete intltool dependency oeqa/target/ssh: don't assume target_dumper is set Sakib Sajal (1): go: upgrade 1.16.5 -> 1.16.7 Saul Wold (2): classes/create-spdx: extend DocumentRef to include name create-spdx: remove trailing comma Scott Weaver (3): bitbake: bitbake: fetch2: fix premirror URI when downloadfilename defined bitbake: bitbake: tests/fetch: add downloadfilename tests bitbake: bitbake: tests/fetch: add and fix npm tests Steve Sakoman (1): connman: add CVE_PRODUCT Tom Rini (1): common-tasks: Add an example of using bbappends to add a file Trevor Woerner (1): hello-mod/hello.c: convert to module_init/module_exit Valentin Danaila (1): bitbake: fetch2/s3: allow to switch profile from environment variable Vyacheslav Yurkov (1): ref-manual: add overlayfs class Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: I194b13991cbaac7ae9e20cc2b552b508ab879905
Diffstat (limited to 'poky/documentation/ref-manual')
-rw-r--r--poky/documentation/ref-manual/classes.rst51
-rw-r--r--poky/documentation/ref-manual/devtool-reference.rst73
-rw-r--r--poky/documentation/ref-manual/history.rst74
-rw-r--r--poky/documentation/ref-manual/index.rst1
-rw-r--r--poky/documentation/ref-manual/resources.rst13
-rw-r--r--poky/documentation/ref-manual/system-requirements.rst5
-rw-r--r--poky/documentation/ref-manual/tasks.rst31
-rw-r--r--poky/documentation/ref-manual/terms.rst8
-rw-r--r--poky/documentation/ref-manual/variables.rst46
9 files changed, 149 insertions, 153 deletions
diff --git a/poky/documentation/ref-manual/classes.rst b/poky/documentation/ref-manual/classes.rst
index 3af023895..5c60fd8c8 100644
--- a/poky/documentation/ref-manual/classes.rst
+++ b/poky/documentation/ref-manual/classes.rst
@@ -543,7 +543,7 @@ which the OpenEmbedded build system places the generated objects built
from the recipes. By default, the :term:`B` directory is set to the
following, which is separate from the source directory (:term:`S`)::
- ${WORKDIR}/${BPN}/{PV}/
+ ${WORKDIR}/${BPN}-{PV}/
See these variables for more information:
:term:`WORKDIR`, :term:`BPN`, and
@@ -1710,6 +1710,55 @@ one such example. However, being aware of this class can reduce the
proliferation of different versions of similar classes across multiple
layers.
+.. _ref-classes-overlayfs:
+
+``overlayfs.bbclass``
+=======================
+
+It's often desired in Embedded System design to have a read-only rootfs.
+But a lot of different applications might want to have read-write access to
+some parts of a filesystem. It can be especially useful when your update mechanism
+overwrites the whole rootfs, but you may want your application data to be preserved
+between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way
+to achieve that by means of ``overlayfs`` and at the same time keeping the base
+rootfs read-only.
+
+To use this class, set a mount point for a partition ``overlayfs`` is going to use as upper
+layer in your machine configuration. The underlying file system can be anything that
+is supported by ``overlayfs``. This has to be done in your machine configuration::
+
+ OVERLAYFS_MOUNT_POINT[data] = "/data"
+
+.. note::
+
+ * QA checks fail to catch file existence if you redefine this variable in your recipe!
+ * Only the existence of the systemd mount unit file is checked, not its contents.
+ * To get more details on ``overlayfs``, its internals and supported operations, please refer
+ to the official documentation of the `Linux kernel <https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html>`_.
+
+The class assumes you have a ``data.mount`` systemd unit defined elsewhere in your BSP
+(e.g. in ``systemd-machine-units`` recipe) and it's installed into the image.
+
+Then you can specify writable directories on a recipe basis (e.g. in my-application.bb)::
+
+ OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application"
+
+To support several mount points you can use a different variable flag. Assuming we
+want to have a writable location on the file system, but do not need that the data
+survives a reboot, then we could have a ``mnt-overlay.mount`` unit for a ``tmpfs`` file system.
+
+In your machine configuration::
+
+ OVERLAYFS_MOUNT_POINT[mnt-overlay] = "/mnt/overlay"
+
+and then in your recipe::
+
+ OVERLAYFS_WRITABLE_PATHS[mnt-overlay] = "/usr/share/another-application"
+
+.. note::
+
+ The class does not support the ``/etc`` directory itself, because ``systemd`` depends on it.
+
.. _ref-classes-own-mirrors:
``own-mirrors.bbclass``
diff --git a/poky/documentation/ref-manual/devtool-reference.rst b/poky/documentation/ref-manual/devtool-reference.rst
index 1862c481d..a1a8bcdc9 100644
--- a/poky/documentation/ref-manual/devtool-reference.rst
+++ b/poky/documentation/ref-manual/devtool-reference.rst
@@ -78,7 +78,7 @@ has a number of sub-commands for each function. You can run
As directed in the general help output, you can
get more syntax on a specific command by providing the command name and
-using "--help"::
+using ``--help``::
$ devtool add --help
NOTE: Starting bitbake server...
@@ -284,10 +284,7 @@ is identified using the ``EDITOR`` variable, on the specified recipe.
When you use the ``devtool edit-recipe`` command, you must supply the
root name of the recipe (i.e. no version, paths, or extensions). Also,
the recipe file itself must reside in the workspace as a result of the
-``devtool add`` or ``devtool upgrade`` commands. However, you can
-override that requirement by using the "-a" or "--any-recipe" option.
-Using either of these options allows you to edit any recipe regardless
-of its location.
+``devtool add`` or ``devtool upgrade`` commands.
.. _devtool-updating-a-recipe:
@@ -331,23 +328,37 @@ Checking on the Upgrade Status of a Recipe
Upstream recipes change over time. Consequently, you might find that you
need to determine if you can upgrade a recipe to a newer version.
-To check on the upgrade status of a recipe, use the
-``devtool check-upgrade-status`` command. The command displays a table
-of your current recipe versions, the latest upstream versions, the email
-address of the recipe's maintainer, and any additional information such
-as commit hash strings and reasons you might not be able to upgrade a
-particular recipe.
+To check on the upgrade status of a recipe, you can use the
+``devtool latest-version recipe`` command, which quickly shows the current
+version and the latest version available upstream. To get a more global
+picture, use the ``devtool check-upgrade-status`` command, which takes a
+list of recipes as input, or no arguments, in which case it checks all
+available recipes. This command will only print the recipes for which
+a new upstream version is available. Each such recipe will have its current
+version and latest upstream version, as well as the email of the maintainer
+and any additional information such as the commit hash or reason for not
+being able to upgrade it, displayed in a table.
+
+This upgrade checking mechanism relies on the optional :term:`UPSTREAM_CHECK_URI`,
+:term:`UPSTREAM_CHECK_REGEX`, :term:`UPSTREAM_CHECK_GITTAGREGEX`,
+:term:`UPSTREAM_CHECK_COMMITS` and :term:`UPSTREAM_VERSION_UNKNOWN`
+variables in package recipes.
.. note::
+ - Most of the time, the above variables are unnecessary. They are only
+ required when upstream does something unusual, and default
+ mechanisms cannot find the new upstream versions.
+
- For the ``oe-core`` layer, recipe maintainers come from the
:yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>`
file.
- If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)`
- rather than a
- tarball, the commit hash points to the commit that matches the
- recipe's latest version tag.
+ rather than a tarball, the commit hash points to the commit that matches
+ the recipe's latest version tag, or in the absence of suitable tags,
+ to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1``
+ in the recipe).
As with all ``devtool`` commands, you can get help on the individual
command::
@@ -372,29 +383,25 @@ Following is a partial example table that reports on all the recipes.
Notice the reported reason for not upgrading the ``base-passwd`` recipe.
In this example, while a new version is available upstream, you do not
want to use it because the dependency on ``cdebconf`` is not easily
-satisfied.
-
-.. note::
-
- When a reason for not upgrading displays, the reason is usually
- written into the recipe using the ``RECIPE_NO_UPDATE_REASON``
- variable. See the
- :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
- recipe for an example.
+satisfied. Maintainers can explicit the reason that is shown by adding
+the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
+See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
+for an example.
::
$ devtool check-upgrade-status
...
- NOTE: acpid 2.0.30 2.0.31 Ross Burton <ross.burton@intel.com>
- NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff
- NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff
- .
- .
- .
- NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility
- NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com>
- NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com>
+ INFO: bind 9.16.20 9.16.21 Armin Kuster <akuster808@gmail.com>
+ INFO: inetutils 2.1 2.2 Tom Rini <trini@konsulko.com>
+ INFO: iproute2 5.13.0 5.14.0 Changhyeok Bae <changhyeok.bae@gmail.com>
+ INFO: openssl 1.1.1l 3.0.0 Alexander Kanavin <alex.kanavin@gmail.com>
+ INFO: base-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility
+ ...
+
+Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1``
+in a recipe when there's currently no way to determine its latest upstream
+version.
.. _devtool-upgrading-a-recipe:
@@ -471,7 +478,7 @@ Use the ``devtool build`` command to build your recipe. The
When you use the ``devtool build`` command, you must supply the root
name of the recipe (i.e. do not provide versions, paths, or extensions).
-You can use either the "-s" or the "--disable-parallel-make" options to
+You can use either the ``-s`` or the ``--disable-parallel-make`` options to
disable parallel makes during the build. Here is an example::
$ devtool build recipe
diff --git a/poky/documentation/ref-manual/history.rst b/poky/documentation/ref-manual/history.rst
deleted file mode 100644
index dc0a2ae79..000000000
--- a/poky/documentation/ref-manual/history.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-
-***********************
-Manual Revision History
-***********************
-
-.. list-table::
- :widths: 10 15 40
- :header-rows: 1
-
- * - Revision
- - Date
- - Note
- * - 0.9
- - November 2010
- - The initial document released with the Yocto Project 0.9 Release
- * - 1.0
- - April 2011
- - Released with the Yocto Project 1.0 Release.
- * - 1.1
- - October 2011
- - Released with the Yocto Project 1.1 Release.
- * - 1.2
- - April 2012
- - Released with the Yocto Project 1.2 Release.
- * - 1.3
- - October 2012
- - Released with the Yocto Project 1.3 Release.
- * - 1.4
- - April 2013
- - Released with the Yocto Project 1.4 Release.
- * - 1.5
- - October 2013
- - Released with the Yocto Project 1.5 Release.
- * - 1.6
- - April 2014
- - Released with the Yocto Project 1.6 Release.
- * - 1.7
- - October 2014
- - Released with the Yocto Project 1.7 Release.
- * - 1.8
- - April 2015
- - Released with the Yocto Project 1.8 Release.
- * - 2.0
- - October 2015
- - Released with the Yocto Project 2.0 Release.
- * - 2.1
- - April 2016
- - Released with the Yocto Project 2.1 Release.
- * - 2.2
- - October 2016
- - Released with the Yocto Project 2.2 Release.
- * - 2.3
- - May 2017
- - Released with the Yocto Project 2.3 Release.
- * - 2.4
- - October 2017
- - Released with the Yocto Project 2.4 Release.
- * - 2.5
- - May 2018
- - Released with the Yocto Project 2.5 Release.
- * - 2.6
- - November 2018
- - Released with the Yocto Project 2.6 Release.
- * - 2.7
- - May 2019
- - Released with the Yocto Project 2.7 Release.
- * - 3.0
- - October 2019
- - Released with the Yocto Project 3.0 Release.
- * - 3.1
- - April 2020
- - Released with the Yocto Project 3.1 Release.
-
diff --git a/poky/documentation/ref-manual/index.rst b/poky/documentation/ref-manual/index.rst
index 5cf10c5c2..a746dde49 100644
--- a/poky/documentation/ref-manual/index.rst
+++ b/poky/documentation/ref-manual/index.rst
@@ -25,6 +25,5 @@ Yocto Project Reference Manual
varlocality
faq
resources
- history
.. include:: /boilerplate.rst
diff --git a/poky/documentation/ref-manual/resources.rst b/poky/documentation/ref-manual/resources.rst
index 5ffd2b399..c94238466 100644
--- a/poky/documentation/ref-manual/resources.rst
+++ b/poky/documentation/ref-manual/resources.rst
@@ -90,12 +90,12 @@ For more Yocto Project-related mailing lists, see the
Internet Relay Chat (IRC)
=========================
-Two IRC channels on Freenode are available for the Yocto Project and
-Poky discussions:
+Two IRC channels on `Libera Chat <https://libera.chat/>`__
+are available for the Yocto Project and OpenEmbedded discussions:
- ``#yocto``
-- ``#poky``
+- ``#oe``
.. _resources-links-and-related-documentation:
@@ -187,9 +187,10 @@ Here is a list of resources you might find helpful:
implementation of Bugzilla for logging and tracking Yocto Project
defects.
-- *Internet Relay Chat (IRC):* Two IRC channels on Freenode are
- available for Yocto Project and Poky discussions: ``#yocto`` and
- ``#poky``, respectively.
+- *Internet Relay Chat (IRC):* Two IRC channels on
+ `Libera Chat <https://libera.chat/>`__ are
+ available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and
+ ``#oe``, respectively.
- `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__\ *:* An
open-source machine emulator and virtualizer.
diff --git a/poky/documentation/ref-manual/system-requirements.rst b/poky/documentation/ref-manual/system-requirements.rst
index e9d995c61..5e5c105d6 100644
--- a/poky/documentation/ref-manual/system-requirements.rst
+++ b/poky/documentation/ref-manual/system-requirements.rst
@@ -4,7 +4,7 @@
System Requirements
*******************
-Welcome to the Yocto Project Reference Manual! This manual provides
+Welcome to the Yocto Project Reference Manual. This manual provides
reference information for the current release 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
@@ -277,7 +277,8 @@ installer and automatically installs the tools for you:
1. Execute the ``install-buildtools`` script. Here is an example::
$ cd poky
- $ scripts/install-buildtools --without-extended-buildtools \
+ $ scripts/install-buildtools \
+ --without-extended-buildtools \
--base-url &YOCTO_DL_URL;/releases/yocto \
--release yocto-&DISTRO; \
--installer-version &DISTRO;
diff --git a/poky/documentation/ref-manual/tasks.rst b/poky/documentation/ref-manual/tasks.rst
index ecc701856..4edae3339 100644
--- a/poky/documentation/ref-manual/tasks.rst
+++ b/poky/documentation/ref-manual/tasks.rst
@@ -438,37 +438,6 @@ Manually Called Tasks
These tasks are typically manually triggered (e.g. by using the
``bitbake -c`` command-line option):
-.. _ref-tasks-checkpkg:
-
-``do_checkpkg``
----------------
-
-Provides information about the recipe including its upstream version and
-status. The upstream version and status reveals whether or not a version
-of the recipe exists upstream and a status of not updated, updated, or
-unknown.
-
-To check the upstream version and status of a recipe, use the following
-devtool commands::
-
- $ devtool latest-version
- $ devtool check-upgrade-status
-
-See the ":ref:`ref-manual/devtool-reference:\`\`devtool\`\` quick reference`"
-chapter for more information on
-``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`"
-section for information on checking the upgrade status of a recipe.
-
-To build the ``checkpkg`` task, use the ``bitbake`` command with the
-"-c" option and task name::
-
- $ bitbake core-image-minimal -c checkpkg
-
-By default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g.
-``$BUILD_DIR/tmp/log``).
-
-.. _ref-tasks-checkuri:
-
``do_checkuri``
---------------
diff --git a/poky/documentation/ref-manual/terms.rst b/poky/documentation/ref-manual/terms.rst
index 32658051a..e5a7565df 100644
--- a/poky/documentation/ref-manual/terms.rst
+++ b/poky/documentation/ref-manual/terms.rst
@@ -367,10 +367,16 @@ universal, the list includes them just in case:
section in the Yocto Project Overview and Concepts Manual.
:term:`Task`
- A unit of execution for BitBake (e.g.
+ A per-recipe unit of execution for BitBake (e.g.
:ref:`ref-tasks-compile`,
:ref:`ref-tasks-fetch`,
:ref:`ref-tasks-patch`, and so forth).
+ One of the major benefits of the build system is that, since each
+ recipe will typically spawn the execution of numerous tasks,
+ it is entirely possible that many tasks can execute in parallel,
+ either tasks from separate recipes or independent tasks within
+ the same recipe, potentially up to the parallelism of your
+ build system.
:term:`Toaster`
A web interface to the Yocto Project's :term:`OpenEmbedded Build System`.
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst
index d5ac1926b..dbe02ab27 100644
--- a/poky/documentation/ref-manual/variables.rst
+++ b/poky/documentation/ref-manual/variables.rst
@@ -5391,7 +5391,7 @@ system and gives an overview of their function and contents.
The list of packages the recipe creates. The default value is the
following::
- ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
+ ${PN}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
During packaging, the :ref:`ref-tasks-package` task
goes through :term:`PACKAGES` and uses the :term:`FILES`
@@ -6132,6 +6132,13 @@ system and gives an overview of their function and contents.
BitBake User Manual for additional information on tasks and
dependencies.
+ :term:`RECIPE_NO_UPDATE_REASON`
+ If a recipe should not be replaced by a more recent upstream version,
+ putting the reason why in this variable in a recipe allows
+ ``devtool check-upgrade-status`` command to display it, as explained
+ in the ":ref:`ref-manual/devtool-reference:checking on the upgrade status of a recipe`"
+ section.
+
:term:`REQUIRED_DISTRO_FEATURES`
When inheriting the
:ref:`features_check <ref-classes-features_check>`
@@ -7503,6 +7510,7 @@ system and gives an overview of their function and contents.
${base_libdir} \
${nonarch_base_libdir} \
${datadir} \
+ /sysroot-only \
"
:term:`SYSROOT_DIRS_BLACKLIST`
@@ -7516,10 +7524,16 @@ system and gives an overview of their function and contents.
${mandir} \
${docdir} \
${infodir} \
- ${datadir}/locale \
+ ${datadir}/X11/locale \
${datadir}/applications \
+ ${datadir}/bash-completion \
${datadir}/fonts \
+ ${datadir}/gtk-doc/html \
+ ${datadir}/installed-tests \
+ ${datadir}/locale \
${datadir}/pixmaps \
+ ${datadir}/terminfo \
+ ${libdir}/${BPN}/ptest \
"
:term:`SYSROOT_DIRS_NATIVE`
@@ -8476,9 +8490,21 @@ system and gives an overview of their function and contents.
install initscripts package them in the main package for the recipe,
you rarely need to set this variable in individual recipes.
+ :term:`UPSTREAM_CHECK_COMMITS`
+ You can perform a per-recipe check for what the latest upstream
+ source code version is by calling ``devtool latest-version recipe``. If
+ the recipe source code is provided from Git repositories, but
+ releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS`
+ to ``1`` in the recipe, and the OpenEmbedded build system
+ will compare the latest commit with the one currently specified
+ by the recipe (:term:`SRCREV`).
+ ::
+
+ UPSTREAM_CHECK_COMMITS = "1"
+
:term:`UPSTREAM_CHECK_GITTAGREGEX`
You can perform a per-recipe check for what the latest upstream
- source code version is by calling ``bitbake -c checkpkg`` recipe. If
+ source code version is by calling ``devtool latest-version recipe``. If
the recipe source code is provided from Git repositories, the
OpenEmbedded build system determines the latest upstream version by
picking the latest tag from the list of all repository tags.
@@ -8501,7 +8527,7 @@ system and gives an overview of their function and contents.
:term:`UPSTREAM_CHECK_URI`
You can perform a per-recipe check for what the latest upstream
- source code version is by calling ``bitbake -c checkpkg`` recipe. If
+ source code version is by calling ``devtool latest-version recipe``. If
the source code is provided from tarballs, the latest version is
determined by fetching the directory listing where the tarball is and
attempting to find a later tarball. When this approach does not work,
@@ -8511,6 +8537,18 @@ system and gives an overview of their function and contents.
UPSTREAM_CHECK_URI = "recipe_url"
+ :term:`UPSTREAM_VERSION_UNKNOWN`
+ You can perform a per-recipe check for what the latest upstream
+ source code version is by calling ``devtool latest-version recipe``.
+ If no combination of the :term:`UPSTREAM_CHECK_URI`, :term:`UPSTREAM_CHECK_REGEX`,
+ :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in
+ the recipe allows to determine what the latest upstream version is,
+ you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe
+ to acknowledge that the check cannot be performed.
+ ::
+
+ UPSTREAM_VERSION_UNKNOWN = "1"
+
:term:`USE_DEVFS`
Determines if ``devtmpfs`` is used for ``/dev`` population. The
default value used for :term:`USE_DEVFS` is "1" when no value is