Commit Graph

2493 Commits

Author SHA1 Message Date
Jörg Sommer
b0f2fd0fad documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
documented. To show its usage another example from the meta-freescale layer
was picked.

(From yocto-docs rev: 8b227582efbe9957026cdce4aef5621661af1fa5)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:06 +00:00
Enguerrand de Ribaucourt
ed6c38e3af manuals: document VSCode extension
The VSCode extension is now officially maintained and published by the
Yocto Project so it should be referenced in the manuals to help users
discover it.

I located the most relevant places to reference the extension by looking
at how the old Eclipse plugin was documented in the 2.6 manuals as well
as the current Toaster references.

(From yocto-docs rev: 645153504690aa8a69b028e95a5e9d2da9644cf1)

Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Adrian Freihofer
f72759de57 ref-manual: document cmake-qemu class
(From yocto-docs rev: b2e396bd970ea8f27ba575b49c1489e2181442b8)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Maxin B. John
b5b64bd0e3 ref-manual: classes: remove insserv bbclass
insserv.bbclass was removed from oe-core:

commit e6bb5dbb62
Author: Richard Purdie <richard.purdie@linuxfoundation.org>
Date:   Sun May 10 12:30:49 2015 +0100

insserv: Remove

(From yocto-docs rev: 41a15a80a325cb63a41be81e632ec2799bfb2957)

Signed-off-by: Maxin John <maxin.john@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Michael Opdenacker
5841968223 ref-manual: update tested and supported distros
According to currently active workers
https://autobuilder.yoctoproject.org/typhoon/#/workers

Also correct the text saying that SANITY_TESTED_DISTROS
lists currently tested distros.

Also replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9,
as we update our workers anyway.

(From yocto-docs rev: bceadfad0954e8473b0e87bba8d6b1e67fd88eef)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Etienne Cordonnier
a1ae83c59b manuals: document minidebuginfo
(From yocto-docs rev: 1a6327f2d92b390248afb45119d79bb05cda3dcc)

Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-18 13:18:55 +00:00
Michael Opdenacker
dd67934e5f ref-manual: releases.svg: update nanbield release status
- nanbield is now released
- update the start and end dates

(From yocto-docs rev: 81afa3c95276f9e3fbd1f282ad5954d591fbbb95)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-20 10:59:40 +00:00
Paul Barker
9723982ecf ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults
After the following meta-yocto commits, MIRRORS & PREMIRRORS are no
longer set in the poky distro config file:

  67b79df4fbff ("poky.conf: remove redundant MIRRORS")
  1b71a3b9418f ("poky: Drop PREMIRRORS entries for scms")

(From yocto-docs rev: bc84dd0b6cdb1b2432ae60c036df9ee15cd53f34)

Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-20 10:59:40 +00:00
Michael Opdenacker
0593fd3416 ref-manual: classes: explain cml1 class name
(From yocto-docs rev: 0ee4b7417087c105a4419b316c6b2c195c343f82)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Martin Jansa <martin.jansa@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
7a026c41aa ref-manual: remove semicolons from *PROCESS_COMMAND variables
In nanbield these are no longer needed - spaces are sufficient.
The code still handles any semicolons (replacing them with spaces before
interpreting the value), but let's avoid people adding them from now on
in case we decide to change that in future.

(From yocto-docs rev: 2947f6309f86cdf5322a39d4420e77431a8e3572)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Paul Eggleton
27949b33b7 ref-manual: update SDK_NAME variable documentation
Update for changes in nanbield. Note that I am documenting what is set
by poky.conf here (since this is Yocto Project documentation), which is
slightly different from what is done in meta/conf/bitbake.conf.

(From yocto-docs rev: 9764cb9e19788eb1caea0d2e95fbe7a5c19887d4)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Paul Eggleton
736705804b Remove references to apm in MACHINE_FEATURES
apm is no longer supported in nanbield.

(From yocto-docs rev: fa07d34db3b5ba670ed2dc1228ffb3c0c09b3c08)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
5466a06f17 ref-manual: variables: remove SERIAL_CONSOLES_CHECK
No longer in use in Poky (dropped in Nanbield through
multiple commits)

(From yocto-docs rev: e5d39e85a0db27bfc857fae9649f799179888eee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
f89f69bc04 ref-manual: variables: add RECIPE_MAINTAINER
(From yocto-docs rev: 30e41530402a4f9c37f77e89bae7469b68aad901)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
e87f2f8e07 ref-manual: variables: mention new CDN for SSTATE_MIRRORS
(From yocto-docs rev: 4ef0c24b206d71c348ff657a2ab83ab857539fb6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
a79cfdf1e3 ref-manual: document cargo_c class
(From yocto-docs rev: 74fc6a70d4636b37fe4eab290ea974e0f1531dbf)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Frederic Martinsons <frederic.martinsons@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
415ff3a78c ref-manual: document MESON_TARGET
(From yocto-docs rev: 8109eeb5b7a4e5b2f50047e049ce0295bdc94856)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
e0800e8d8a manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPS
- Mention CVE_STATUS_GROUPS in the development manual
  (otherwise only present in the reference manual, but with
  no reference to it)

- In the reference manual description of CVE_STATUS,
  link back to the development manual, to provide context.

(From yocto-docs rev: cfef5fe41b6c819e783c88829448ae38141650a5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
9bf8094bda ref-manual: document KERNEL_STRIP
(From yocto-docs rev: 0e1861dcb8819b86aba6a3e024efb8bfe4c300ad)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
9bc8bfc078 ref-manual: variables: document OEQA_REPRODUCIBLE_TEST_PACKAGE
Introduced by
https://git.yoctoproject.org/poky/commit/?id=88abdec715ed0c1f613c9b5132cd45db741d5c65

(From yocto-docs rev: 2e64352653cd7e89a2b08d84d6f7a1e039d4346a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
f32fad635d ref-manual: document KERNEL_LOCALVERSION
Introduced by
https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0

(From yocto-docs rev: 4bdd4976667b802895b13541b77191a65335a175)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Bruce Ashfield <bruce.ashfield@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Eero Aaltonen
34c19d6ece ref-manual: add systemd-resolved to distro features
systemd-resolved is a distro feature added in poky commit
6f30e3586e

(From yocto-docs rev: 2adb9c0a37f7bdbb293e78d71c872ca3bd9c06c4)

Signed-off-by: Eero Aaltonen <eero.aaltonen@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:16 +00:00
BELHADJ SALEM Talel
1b04f4422e ref-manual: variables: add example for SYSROOT_DIRS variable
(From yocto-docs rev: 65b62118da6f355e56c489c6be08ba9ea94b9f04)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
6a70a3366d ref-manual: variables: add TOOLCHAIN_OPTIONS variable
(From yocto-docs rev: 6f7bd97a6d3d6d8cfd149a7e07df35da4141e650)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
ca1e27016d ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVE
(From yocto-docs rev: 8aa25e2a668d35bab2f79457248abcde92dc92aa)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Jérémy Rosen
381ef628fa ref-manual: Add documentation for the unimplemented-ptest QA warning
(From yocto-docs rev: d90106ff2d905e457659acdb65a91ce5dcfdd05e)

Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Quentin Schulz
efd54e4d1d ref-manual: variables: provide no-match example for COMPATIBLE_MACHINE
COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages
for a specific set of machines.

In some cases, it may make more sense to have the logic inverted and
have the recipe always forbidden except for hand-picked machines. Such
could be the case for pieces of software that only support some
architectures. In that scenario, it is sometimes a bit easier on the eye
and for maintenance to use the OVERRIDES mechanism but for that, a
default should be set.

COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$"
COMPATIBLE_MACHINE:mips64 = "^(mips64)$"

wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is
assumed compatible and therefore, if no default is provided we enter
that case.

Hence, we need to add

COMPATIBLE_MACHINE = "^$"

as default so that it only matches the empty string, which isn't
possible for MACHINEOVERRIDES.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 52196d39bc85de267daffb0074eb59786751f57d)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
f70a86b27e ref-manual: Fix PACKAGECONFIG term and add an example
PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS
and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...)
So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables.

I added a custom example that can help understanding very well PACKAGECONFIG.

(From yocto-docs rev: 7f26b0c0a08d6be9810128369265b0c494e7191b)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
8fd6d222ed manuals: update list of supported machines
The EdgeRouter machine is no longer supported.
https://git.yoctoproject.org/poky/commit/?id=0c64d0e4317e3749f7f7ed9ecd5d08bbb0cedc9e

(From yocto-docs rev: e600522f2d2514bdd888c91043b9c59563ee7a6d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
203c78b719 manuals: update linux-yocto append examples
(From yocto-docs rev: 0d195d66e434ddedd33bf8db89643fa5ab192e29)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Arne Schwerdt
1c90ad84f3 ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipes
(From yocto-docs rev: fcc9b54cc46a0831f79a96e041cbe8deed58cf66)

Signed-off-by: Arne Schwerdt <arne.schwerdt@elbbits.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
a5896803e7 ref-manual: releases.svg: Scarthgap is now version 5.0
According to https://wiki.yoctoproject.org/wiki/Releases

(From yocto-docs rev: 88348eb6eaa589a735b35b8ee726b9523f46e54f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-09 15:52:16 +01:00
Roland Hieber
10e67c22e6 ref-manual: point outdated link to the new location
(From yocto-docs rev: afdfa717aec5cd382054030a2d1e1655277bc5a5)

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-19 15:57:35 +01:00
Ross Burton
6e7bf979f2 manuals: document LICENSE_FLAGS_DETAILS
(From yocto-docs rev: 299c9b295a8476abdb32fba01ac2f45efacea6f1)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-19 15:57:35 +01:00
Michael Opdenacker
0c8b5d0e69 contributor guide: call section "Reporting a defect"
Instead of "Submitting a defect".

We all write bugs, and nobody needs documentation
support for doing so!

(From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
16dff2be01 ref-manual: remove AUTHOR variable
Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf

(From yocto-docs rev: e7da4d122313f369be1c680dadd76ea53ba8dd04)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
34864ad94c ref-manual: update supported distro versions
- Update according to changes in SANITY_TESTED_DISTROS
  (meta-poky/conf/distro/poky.conf)

- No longer declare as "Supported" the distributions versions
  which are End of Life for their vendors, as some of them
  (Ubuntu for example) ship updates to subscribers only,
  which the Yocto Project has no access to.

- List distribution versions which were previously tested
  for the branch of the Yocto Project being considered
  (should be an empty list on master, until the next
  release is made).

(From yocto-docs rev: a2c0918493fb85235d90edd782ec14fa75d10cf1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
2090a416ad ref-manual: classes.rst: fix location of _ref-classes-ccache
(From yocto-docs rev: c2204f3b61ec2fbd36c6f216a66fe5495edd6b90)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Frederic Martinsons
0537f6f4fc ref-manual: classes.rst: suppress rust-hello-world reference, add ptest-cargo class
(From yocto-docs rev: 8b1f41ebef4e02d9b0d50ce7e69cb90c83eb4324)

Signed-off-by: Frederic Martinsons <frederic.martinsons@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
8a11abf6a9 manuals: create a dedicated "Contributor Guide" document
Starting from the original contents of dev-manual/changes.rst
and from text contributed by Richard Purdie.

(From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Alexander Kanavin
6f361c81ba ref-manual: document image-specific variant of INCOMPATIBLE_LICENSE
This has been around without being properly documented since 2019 (!!!),
and is nowadays the preferred method for enforcing license restrictions,
especially since meta-gplv2 is officially obsolete.

(From yocto-docs rev: efa1c57ecec934998792b7851b4a162be92c8b23)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:11 +01:00
Andrej Valek
e100e3e0b3 ref-manual: document CVE_STATUS and CVE_CHECK_STATUSMAP
Deprecate CVE_CHECK_IGNORE with CVE_STATUS

(From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733)

Signed-off-by: Andrej Valek <andrej.valek@siemens.com>
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:11 +01:00
Michael Opdenacker
7d66f14574 ref-manual: LTS releases now supported for 4 years
(From yocto-docs rev: 6676ab2c6a1fd8cc2ad7b3e2da98f95118524c61)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:11 +01:00
Michael Opdenacker
25de21656a ref-manual: releases.svg: updates
- Kirkstone is now a 4 year LTS
- Add future Scarthgap LTS
- Update document metadata: license, title

(From yocto-docs rev: 12d40f56edc755db9724b7382e30082874f29699)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:10 +01:00
Ulrich Ölmann
9f51de2f9b ref-manual: classes: kernel-fitimage: refine role of INITRAMFS_IMAGE_BUNDLE
Although it might seem a little bit pedantic this patch describes what the class
actually checks (see e.g. [1]) and kernel.bbclass per default sets the parameter
INITRAMFS_IMAGE_BUNDLE to the empty string (see [2]) which already satisfies
that check without the need of additionally explicitly setting it to '0'.

[1] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel-fitimage.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n667
[2] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n37

(From yocto-docs rev: dc486daa7cf8536435c3364a842f802b6fba1e1a)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:10 +01:00
Ulrich Ölmann
7d4c1b2dd9 ref-manual: classes: kernel-fitimage: fix typos
(From yocto-docs rev: 054015241abd7ccde30e3cc14f95bb15a8e3b75d)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:10 +01:00
Ulrich Ölmann
7be9b1ff81 ref-manual: classes: kernel-fitimage: fix source of imagetype
The actual code in kernel-fitimage.bbclass checks if "fitImage" is listed in
KERNEL_IMAGETYPES (see e.g. [1]) which is a merge of KERNEL_IMAGETYPE,
KERNEL_ALT_IMAGETYPE and KERNEL_IMAGETYPES (see [2]).

[1] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel-fitimage.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n9
[2] https://git.yoctoproject.org/poky/tree/meta/classes-recipe/kernel.bbclass?h=4.3_M1&id=cc97d775cb402df0d4122bf54eab1a5198c98471#n74

(From yocto-docs rev: a0f79745a80c7a88167d83d905e75e1fcd5f054d)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:10 +01:00
Luca Ceresoli
13b646c0e1 ref-manual: classes: devicetree: fix sentence saying the same thing twice
This sentence was originally written based on the comments in the .bbclass
file, but further editing led to saying the same thing twice. Remove the
duplication and also reword it to make it generally better.

Fixes: f65816f5ea62 ("ref-manual: classes.rst: document devicetree.bbclass")
Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
(From yocto-docs rev: cbacc8a77aca68c5b25c8cad42bc4c88275cfc09)

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-24 12:23:01 +01:00
Quentin Schulz
ae8e1dc990 docs: ref-manual: terms: fix incorrect note directive
The directive is followed by two colons and not only one, so let's add
the missing one.

c.f. https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-note

Fixes: 952c7e6dee49 ("manuals: improve initramfs details")
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 203b75e9473b5905ce216dfbc2112dcb02e81f2d)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-24 12:23:01 +01:00
Quentin Schulz
dae1bc6898 docs: fix unnecessary double white space
There's no need for double white spaces here so let's just remove them.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-24 12:23:01 +01:00