Commit Graph
48 Commits
Author SHA1 Message Date
Paul Eggleton fd6e9609d1 migration-3.4: add some extra packaging notes
Add some notes on minor packaging changes that I missed earlier.

(From yocto-docs rev: a4f345f888b466bd1459b767c1b8cf8b9397e27e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-22 22:15:33 +01:00
Paul Eggleton a43cb3d607 poky.yaml: fix lz4 package name for older Ubuntu versions
It turns out that for Ubuntu, lz4 is the valid package name for newer
versions (e.g. 20.04 LTS) but not for older ones (e.g. 18.04 LTS, where
the correct package is liblz4-tool). In 20.04 the lz4 package includes
liblz4-tool in its "provides" so it's best to list that one for now.

(From yocto-docs rev: 2a4e259d2786c14b19a632b3a8f1a06383b6a80c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-22 22:15:33 +01:00
Paul Eggleton b2170a460b migration: tweak introduction section
Ensure we have a brief introductory section and tweak the general
migration considerations a little.

(From yocto-docs rev: b127348bbc6a7a6e48ee14434fffc56e08aa9e02)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton 64f1f876a1 migration-3.4: add additional migration info
Add migration instructions gathered by combing the commits in this
release.

(From yocto-docs rev: 2fc89fa1d4e29d2498d5b736ffe85c1cdc8b62e7)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton 9ababc0b5b poky.yaml: add lz4 and zstd to essential host packages
These are now required so update the corresponding distro-specific
lists used in the system requirements documentation.

(From yocto-docs rev: 604deb5c30a8808a60187f81645fa08b67ef2de9)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton 9b0f90ff6a ref-manual: remove meta class
This was recently removed so remove the reference to it.

(From yocto-docs rev: 53f52adf212e35e7588a90e94b03b5cfae6f867c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton 1088e2d9d1 migration-3.4: tweak overrides change section
Minor grammar and readability improvements.

(From yocto-docs rev: e33a809d139d52a8aa262a25fe3031a8882dee2e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton 1203d1f24d ref-manual: add mention of DISTUTILS_SETUP_PATH
Add a variable glossary entry and corresponding 3.3 migration
section entry for DISTUTILS_SETUP_PATH.

(From yocto-docs rev: 0823237e6f4b9dbdf48500b3c1e8cc61696fa2d2)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 34a72cf613 ref-manual: migration guide: add release codenames
People will see release codenames in other contexts, and thus it is
useful to mention them explicitly here rather than having to go to the
Releases wiki page to map version number to release codename.

(From yocto-docs rev: fe3a91e8b3ef09b79711b62c6a08643f9444dcec)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton e88b0ba326 ref-manual: add migration section for 3.3 release
(From yocto-docs rev: b8b6e8335be382337fe4adda11d5a90872ff4c79)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 5b11fd8881 ref-manual: tweak buildtools section
Add a joining paragraph and fix the second section so that it makes
sense with the addition of the first one.

(From yocto-docs rev: 8ee993995d9d72873f36e40dda5e3f345901978c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 93e2dd396e ref-manual: fix reference to build-essential
This has been here since the text was added to the DocBook version.

(From yocto-docs rev: 611588b065ab98d7021173525027d16b5ab519c8)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 4af4b69f71 ref-manual: add FIT_KERNEL_COMP_ALG*
Add FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. Examining
OE-Core commit 5c72105e2973e613b5c0f0e6310ffdea6e56c6c7 and the
associated code, these do not enable arbitrary selection of compression
algorithm - only disabling compression - so document them accordingly.

(From yocto-docs rev: 41640526dd87153fdf802b058336c6fb466b8ade)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton e7559be8d5 ref-manual: add passwd-expire to EXTRA_USERS_PARAMS
Add a reference to the recently added passwd-expire command in
EXTRA_USERS_PARAMS.

(From yocto-docs rev: 9a6c8b37a1e6baab4dfb2ffe7b4abdf7dcbb8822)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton bf68c627b1 ref-manual: add python3targetconfig class and remove python 2 references
Add the recently added python3targetconfig class. Also, we no longer
have the python 2 classes, remove all references to those.

(From yocto-docs rev: c63d88656e2fc5361c512d4d9b426260c3e339f3)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 70441f2b73 ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.

(From yocto-docs rev: c1c0b3600f2f6e752faacfc877b80c2dda7cf522)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 71b78ef384 ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossary
(From yocto-docs rev: dc23e9cf8fa161388a52deae5e6c9da54c6573d5)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton 06e98c4b80 overview-manual: fix git command line
There was an en dash here instead of a hyphen; this meant that the
command line could not be copied and pasted verbatim. (Admittedly that
is less likely here than in other examples, but let's correct it
anyway.)

(From yocto-docs rev: 4f289752fab3529516ad44e6e62a1042c339fd13)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton 6a4a9e8333 ref-manual: update/fix text for SDK_VERSION
DISTRO_VERSION snapshot versions use METADATA_REVISION not DATE in
hardknott and thus the default for SDK_VERSION has been updated, so
update it here as well. Additionally, fix the text so it makes sense.

(From yocto-docs rev: 7b0c4229591d6325384800137e9242c2b030e118)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton 8396001238 Use variables for minimum host versions and bump Python to 3.6
Minimum Git, tar, Python and gcc versions are specified in quite a few
different places. Let's add some variables for these so there's no
chance of missing one if they're updated in future. Additionally, for
hardknott the minimum Python version is 3.6 so set that as the value for
Python.

(From yocto-docs rev: 9a802bc4bb0438c2540f360a08c7787caf64408a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton b56736ae76 ref-manual: add METADATA_REVISION and METADATA_BRANCH
These are not new variables, but we are using METADATA_REVISION in a new
place and thus need to refer to it.

(From yocto-docs rev: 3b80ece864e8cc06f09d3d4ee645ddeef5d4eaf6)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton f2a20f7bd0 bitbake: bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.

(Bitbake rev: b32e6c8d4ea2f83fe77021207e9db883fec82d97)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton 1892aae539 bitbake: bitbake-user-manual: document no support for using passwords in git URLs
This is based on the comment added in revision
aded964eed4ce5a725ed1ab477efabc86b1aa481.

(Bitbake rev: 082683da089115d8b6f71f221cabb41ac401f733)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton 07ec4c4ee7 ref-manual: use consistent capitalisation of U-Boot
Change all instances of U-boot to U-Boot.

(From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton f567cda0a9 variables: Add documentation for new kernel-fitimage vars
Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE,
UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS.

(From yocto-docs rev: 3c8c9d419d0137279ba1a4e7d3f381df93d6f12d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton 345fb462ef variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optional
(From yocto-docs rev: 0ba5591c4e8dd194f87837556cedb2b9979bc6df)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton bde537a024 variables: clarify KERNEL_ALT_IMAGETYPE reference
Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an
additional image type.

(From yocto-docs rev: d2f51d310028dfa50584f7dc04ea3627d14d3f1e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton 84c2470929 classes: minor corrections to kernel-fitimage section
Minor syntax and formatting corrections.

(From yocto-docs rev: eda1fae0dc8670ff22f10b591ce14b9bbf0455ce)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton 87b38ee1c1 oe-selftest: fitimage: add test for signing FIT images
Add a new test to verify signing FIT images. Also includes testing for
the newly introduced FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE,
UBOOT_MKIMAGE_SIGN, and UBOOT_MKIMAGE_SIGN_ARGS variables.

(From OE-Core rev: 3c054762278fd8c5dd827dbac15f4fa066e6c19e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton b23d338176 oe-selftest: fitimage: Test for FIT_DESC
Add verification of FIT_DESC to the existing test for kernel-fitimage.

(From OE-Core rev: 1d75a67efe968f1d9161b64e2b7b2d3cf482c968)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton 715591d952 oe-selftest: move FIT image tests to their own module
I'm about to add an additional test, and on the assumption that we might
also add more in future it seems reasonable to have the tests in their own
module.

(From OE-Core rev: 89f620cc142df9b4af6d49a13db96452ec838139)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton 5a25585437 classes/kernel-fitimage: add ability to add additional signing options
Add a UBOOT_MKIMAGE_SIGN_ARGS variable to enable passing additional
options to uboot-mkimage when it is run the second time to perform
signing.

(From OE-Core rev: 8fd7ee7414b45a1feeef7982af3583475902a677)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton ecbf182e89 classes/kernel-fitimage: allow substituting mkimage command
Add a UBOOT_MKIMAGE and UBOOT_MKIMAGE_SIGN variables to allow specifying
an alternative uboot-mkimage executable (or wrapper script/function).

(From OE-Core rev: aee5bac02eff28a75fa1eee646bc511984013aa4)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton be137b8958 classes/kernel-fitimage: add variable for description
Add a FIT_DESC variable to make it possible to change how the
description is set in the FIT image.

(From OE-Core rev: 47c5ea69e1a6c4fd3aa766d5223aff1201a4a1d8)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-20 00:03:04 +00:00
Paul Eggleton 6de21a42a6 ref-manual: add migration info about MLPREFIX changes
Add a migration subsection on the need to add MLPREFIX to conditional
package dependencies in gatesgarth.

(From yocto-docs rev: e202beabfc1282d6999fde0ced89e41c993da27f)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 4f91a3339c ref-manual: add migration info for image-artifact-names
Add some info on the image-artifact-names class change in gatesgarth.

(From yocto-docs rev: 71dd9d92bf58c73f5fb3bd14cf8031bfc794fd3f)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 778ef21609 ref-manual: add IMAGE_LINK_NAME
Add IMAGE_LINK_NAME to the variable glossary.

(From yocto-docs rev: 370551f961a291f7090a8a40a0beea3511274bc1)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 38a2462bc7 ref-manual: add migration section for 3.2
This covers most of the changes that would require action on the part of
the user that I was able to see by scouring the commits. Some of the text
was borrowed from commit messages and edited.

(From yocto-docs rev: 35e9349ba6417765274d7d1ce542e7e6f19dbe26)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 2e59fedd52 ref-manual: add IMAGE_NAME_SUFFIX variable
Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way
back in krogoth.

(From yocto-docs rev: 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton eac7b4bc3e ref-manual: add IMAGE_VERSION_SUFFIX variable
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which
was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME
entries whose defaults use this variable.

(From yocto-docs rev: 1a02c4be8e348687d4f7e09aefc408aaed5f1be5)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 5f2e106d61 ref-manual: add PSEUDO_IGNORE_PATHS
Add a brief variable glossary entry for the new PSEUDO_IGNORE_PATHS
variable.

(From yocto-docs rev: a337bb317dacdeb174397e7ee8258bc74560436b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 209aa9805a ref-manual: QA check updates
* Update for changes to messages
* Add missing QA checks - some added recently, others several releases
  ago

Some of this was borrowed from commit messages (with editing) - in
particular thanks to Alexander Kanavin for the writeup on patch-fuzz.

(From yocto-docs rev: 6a5e846a92068758e49d1810789638b6990bf83d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 249e789fed ref-manual: fix for features_check class change
distro_features_check was renamed to features_check and extended to
support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in
dunfell, but the documentation still needed to be updated.

(From yocto-docs rev: 274eb596582a22883e8b386a07cf32ed45a77d79)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 266e1d6ae8 ref-manual: add reference anchors for each QA check
Make it possible to link to the explanation for a particular QA check.

(From yocto-docs rev: 3f6dc24e0a371feca8fe66c1be8c86e599307854)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30 12:09:21 +00:00
Paul Eggleton 1932b04a1e classes/buildhistory: also save recipe info for native recipes
If we want to also collect SRC_URI for native recipes we need to ensure
that the code that writes out all of the recipe info is called - there
isn't a do_packagedata for native recipes so we need to piggyback on
do_populate_sysroot instead.

(From OE-Core rev: d123606c4bef85c2436b40f51e47b602b7600c0b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-20 11:11:46 +01:00
Paul Eggleton 71191e8e7a classes/buildhistory: record SRC_URI
It can be useful to record SRC_URI into buildhistory for the purposes of
tracking exactly which sources got built (we already have SRCREV) as
well as getting an indication when changes to the SRC_URI relate to
changes in the output.

(From OE-Core rev: 70714795aafc98a6df1df7f944867093eb8cafc7)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-20 11:11:46 +01:00
Paul Eggleton c31ddaba1f ref-manual: add migration section for 3.1
Migration information for the 3.1 release.

(From yocto-docs rev: dda13761733c7f3fe672f45b8d06f6c3fcf8cb30)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
Paul Eggleton 545c067f9a dev-manual: basic updates for npm fetcher changes
Update the npm:// URL and the generated npm recipe, and remove
references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in
general.

(From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00