summaryrefslogtreecommitdiff
path: root/poky/documentation/ref-manual/ref-tasks.rst
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2020-10-27 21:52:24 +0300
committerAndrew Geissler <geissonator@yahoo.com>2020-11-23 23:00:33 +0300
commit4c19ea120a3e7a73dc8470c86744bc95997f1c90 (patch)
treedd2f114bc0a3614b653d1afde08bec22ab646e7e /poky/documentation/ref-manual/ref-tasks.rst
parent5f4b874fc7d6f8941582b97eb688c67dc21efffb (diff)
downloadopenbmc-4c19ea120a3e7a73dc8470c86744bc95997f1c90.tar.xz
poky: subtree update:ad30a6d470..7231c10430
Akira Shibakawa (3): License-Update: attr: Add a missing file to LIC_FILES_CHKSUM. License-Update: kmod: Add a missing file to LIC_FILES_CHKSUM. License-Update: gdk-pixbuf: Fix LICENSE. Alejandro Hernandez Samaniego (1): baremetal-helloworld: Fix install path since S doesnt have a trailing slash Alexander Kanavin (4): ncurses: only include upstream releases in version check python3: fix upstream version check boost-build-native: fix upstream version check selftest/virgl: drop the custom 30 sec timeout Alistair (1): weston-init: Allow setting idle time to 0 Changqing Li (1): toolchain-shar-extract.sh: don't print useless info Charlie Davies (1): bitbake: bitbake: fetch/git: use shlex.quote() to support spaces in SRC_URI url Chen Qi (2): watchdog: use /run instead of /var/run in systemd service file cups: use /run instead /var/run in systemd's unit file David Reyna (1): bitbake: toaster: Enable Gatesgarth branch in place of Zeus Douglas Royds (1): externalsrc: No single-task lock if S != B Joshua Watt (2): ref-variables: Given example for naming sources ref-manual: Document wic --offset option Khairul Rohaizzat Jamaluddin (1): imagefeatures: New test case, test_empty_image, added Khem Raj (5): autotools.bbclass: Order CONFIG_SHELL before CACHED_CONFIGUREVARS boost: Fix build on 32-bit arches with 64bit time_t only mesa: Fix build on 32bit arches supporting 64bit time_t only packagegroup-core-tools-debug: Disable for rv32/glibc as well packagegroup-core-tools-profile: Remove lttng-tools and perf for rv32/glibc Konrad Weihmann (1): lib/oe/rootfs: introduce IMAGE_LOG_CHECK_EXCLUDES Lee Chee Yang (2): libproxy: fix CVE-2020-25219 grub2: fix CVE-2020-10713 Martin Jansa (11): tune-cortexa76ae.inc: Correct TUNE_FEATURES arch-armv7a.inc: fix typo arch-mips.inc: remove duplicated mips64el-o32 from PACKAGE_EXTRA_ARCHS_tune-mips64el-o32 arch-arm64.inc: don't append _be to ARMPKGARCH for tune-aarch64_be tune-mips64r6.inc: fix typo in mipsisa64r6-nf tune-ep9312.inc: add t suffix for thumb to PACKAGE_EXTRA_ARCHS_tune-ep9312 tune-riscv.inc: use nf suffix also for TUNE_PKGARCH tune-supersparc.inc: remove tune-thunderx.inc: don't append _be to ARMPKGARCH for tune-thunderx_be siteinfo: Recognize 32bit PPC LE siteinfo: Recognize bigendian sh3be and sh4be Max Krummenacher (2): linux-firmware: package marvel sdio 8997 firmware linux-firmware: package nvidia firmware Mingli Yu (1): tcl: adapt to potential pseudo changes Naoki Hayama (1): dev/test/ref-manual: Fix typos Neil Armstrong (1): linux-firmware: add Amlogic VDEC firmware package Nicolas Dechesne (4): sdk-manual: use built-in footnotes dev-manual/dev-manual-common-tasks: fix warning sphinx: add 3.1.3 and 3.0.4 release in the switcher dev-manual/dev-manual-common-tasks: fix typos and use extlinks Paul Eggleton (2): classes/buildhistory: record SRC_URI classes/buildhistory: also save recipe info for native recipes Quentin Schulz (17): docs: poky.yaml: use HTTPS for links docs: ref-manual: indentation, links and highlights fixes docs: remove OE_INIT_FILE variable docs: ref-manual: fix typos docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTRO docs: ref-manual: ref-classes: remove dropped tinderclient class docs: ref-manual: ref-system-requirements: update requirements to build Sphinx docs docs: sphinx: yocto-vars: rebuild files when poky.yaml has changed docs: poky.yaml: fix identation in host packages variables docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDS docs: dev-manual-common-tasks: update python webserver example to python3 docs: dev-manual: fix typos, highlights, indentation and links docs: ref-manual: ref-terms: add links to terms in glossary docs: bsp-guide: bsp: fix typos, highlights and links docs: kernel-dev: fix typos, highlights and links docs: kernel-dev-common: add .patch file extension to SRC_URI files docs: kernel-dev-faq: update outdated RDEPENDS_kernel-base Reyna, David (1): bitbake: toaster: Update documentation links to new URLs Richard Purdie (10): layer.conf: Switch to gatesgarth only in preparation for release bitbake: ui/toasterui: Fix startup faults from incorrect event sequencing bitbake: bitbake: Bump version to 1.48.0 ready for the new release oeqa: Add sync call to command execution poky.conf: Bump version for 3.2 gatesgarth release build-appliance-image: Update to master head revision bitbake: tests/fetch: Update upstream master->main branchname transition Revert "classes/buildhistory: also save recipe info for native recipes" valgrind: Fix build on musl after drd fixes build-appliance-image: Update to master head revision Robert Yang (1): weston: Fix PACKAGECONFIG for remoting Roland Hieber (1): devtool: make sure .git/info exists before writing to .git/info/excludes Ross Burton (4): waf: don't assume the waf intepretter is good waf: add ${B} to do_configure[cleandirs] scripts/install-buildtools: Update to 3.2 M3 buildtools glib-2.0: fix parsing of slim encoded tzdata Sourabh Banerjee (1): layer.conf: fix sanity error for PATH variable in extensible SDK workflow Stacy Gaikovaia (2): valgrind: drd: fix pthread intercept test failures bitbake: main: Handle cooker daemon startup error Tim Orling (1): bitbake: lib/bb/ui/knotty: fix typo in parseprogress Victor Kamensky (3): Revert "qemumips: use 34Kf-64tlb CPU emulation" Revert "qemu: add 34Kf-64tlb fictitious cpu type" qemu: change TLBs number to 64 in 34Kf mips cpu model Yi Zhao (1): dhcpcd: add PACKAGECONFIG for ntp/chrony/ypbind hooks Zang Ruochen (1): harfbuzz: Refresh patch akuster (2): busybox: add rev and pgrep kea: add init scripts leimaohui (1): docs: Updated the status of spdx module. zangrc (1): classes: Fixed the problem of undefined variables when compiling meta-toolchain. Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: Ic45bc219b94960751896a0ae3d4923a9f5849e70
Diffstat (limited to 'poky/documentation/ref-manual/ref-tasks.rst')
-rw-r--r--poky/documentation/ref-manual/ref-tasks.rst87
1 files changed, 28 insertions, 59 deletions
diff --git a/poky/documentation/ref-manual/ref-tasks.rst b/poky/documentation/ref-manual/ref-tasks.rst
index 2569306fc5..9ef014139c 100644
--- a/poky/documentation/ref-manual/ref-tasks.rst
+++ b/poky/documentation/ref-manual/ref-tasks.rst
@@ -87,33 +87,30 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
.. note::
- Do not write the output directly to
- ${DEPLOY_DIR_IMAGE}
- , as this causes the sstate mechanism to malfunction.
+ Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes
+ the sstate mechanism to malfunction.
The ``do_deploy`` task is not added as a task by default and
consequently needs to be added manually. If you want the task to run
after :ref:`ref-tasks-compile`, you can add it by doing
-the following: addtask deploy after do_compile Adding ``do_deploy``
-after other tasks works the same way.
+the following:
+::
+
+ addtask deploy after do_compile
+
+Adding ``do_deploy`` after other tasks works the same way.
.. note::
- You do not need to add
- before do_build
- to the
- addtask
- command (though it is harmless), because the
- base
- class contains the following:
+ You do not need to add ``before do_build`` to the ``addtask`` command
+ (though it is harmless), because the ``base`` class contains the following:
::
do_build[recrdeptask] += "do_deploy"
- See the "
- Dependencies
- " section in the BitBake User Manual for more information.
+ See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
+ section in the BitBake User Manual for more information.
If the ``do_deploy`` task re-executes, any previous output is removed
(i.e. "cleaned").
@@ -298,10 +295,8 @@ to locate and apply patch files to the source code.
.. note::
- The build system uses the
- FILESPATH
- variable to determine the default set of directories when searching
- for patches.
+ The build system uses the :term:`FILESPATH` variable to determine the
+ default set of directories when searching for patches.
Patch files, by default, are ``*.patch`` and ``*.diff`` files created
and kept in a subdirectory of the directory holding the recipe file. For
@@ -322,13 +317,8 @@ and patch files needed to build the package.
.. note::
- In the case for the
- bluez5_5.48.bb
- recipe, the
- SRC_URI
- statements are from an include file
- bluez5.inc
- .
+ In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements
+ are from an include file ``bluez5.inc``.
As mentioned earlier, the build system treats files whose file types are
``.patch`` and ``.diff`` as patch files. However, you can use the
@@ -336,9 +326,9 @@ As mentioned earlier, the build system treats files whose file types are
file as a patch file:
::
- SRC_URI = " \\
- git://path_to_repo/some_package \\
- file://file;apply=yes \\
+ SRC_URI = " \
+ git://path_to_repo/some_package \
+ file://file;apply=yes \
"
Conversely, if you have a directory full of patch files and you want to
@@ -356,7 +346,7 @@ the patch phase, you can use the "apply=no" parameter with the
In the
previous example, assuming all the files in the directory holding the
patch files end with either ``.patch`` or ``.diff``, every file would be
-applied as a patch by default except for the patch_file5 patch.
+applied as a patch by default except for the ``patch_file5`` patch.
You can find out more about the patching process in the
":ref:`patching-dev-environment`" section in
@@ -547,7 +537,7 @@ Removes all output files and shared state
(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a
target. Essentially, the ``do_cleansstate`` task is identical to the
:ref:`ref-tasks-clean` task with the added removal of
-shared state (`:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`)
+shared state (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`)
cache.
You can run this task using BitBake as follows:
@@ -561,11 +551,9 @@ scratch is guaranteed.
.. note::
- The
- do_cleansstate
- task cannot remove sstate from a remote sstate mirror. If you need to
- build a target from scratch using remote mirrors, use the "-f" option
- as follows:
+ The ``do_cleansstate`` task cannot remove sstate from a remote sstate
+ mirror. If you need to build a target from scratch using remote mirrors, use
+ the "-f" option as follows:
::
$ bitbake -f -c do_cleansstate target
@@ -605,18 +593,13 @@ Lists all defined tasks for a target.
``do_package_index``
--------------------
-Creates or updates the index in the `:ref:`package-feeds-dev-environment` area.
+Creates or updates the index in the :ref:`package-feeds-dev-environment` area.
.. note::
- This task is not triggered with the
- bitbake -c
- command-line option as are the other tasks in this section. Because
- this task is specifically for the
- package-index
- recipe, you run it using
- bitbake package-index
- .
+ This task is not triggered with the ``bitbake -c`` command-line option as
+ are the other tasks in this section. Because this task is specifically for
+ the ``package-index`` recipe, you run it using ``bitbake package-index``.
Image-Related Tasks
===================
@@ -859,17 +842,3 @@ sure that the machine and metadata branches as specified by the
branches. If these branches do not exist and
:term:`AUTOREV` is not being used, the
``do_validate_branches`` task fails during the build.
-
-Miscellaneous Tasks
-===================
-
-The following sections describe miscellaneous tasks.
-
-.. _ref-tasks-spdx:
-
-``do_spdx``
------------
-
-A build stage that takes the source code and scans it on a remote
-FOSSOLOGY server in order to produce an SPDX document. This task applies
-only to the :ref:`spdx <ref-classes-spdx>` class.