Commit Graph

11 Commits

Author SHA1 Message Date
Robert P. J. Day
034a6278ce dev manual, CH 3: update code snippets to be more current
Nothing major, just copy-and-paste from master branch to replace aging
code examples, and a little grammmar cleanup.

(From yocto-docs rev: 74057a1ffd682754e81f5f7fbde9f233e14a0d00)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
1180a5b591 dev-manual: replace WORKDIR with UNPACKDIR where appropriate
(From yocto-docs rev: 25ea8e2a0428b6cb66402283e64144d5ce61daf6)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Antonin Godard
d6e3e5c00d Drop support for BB_DANGLINGAPPENDS_WARNONLY
Support for this variable was dropped in BitBake, see commit
fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for
BB_DANGLINGAPPENDS_WARNONLY").

Drop this variable here as well and rewrite the "Appending Other Layers
Metadata With Your Layer" section to advise to rename the recipe and
check if the bbappend is still relevant - otherwise to use BBWARN.

(From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-28 10:57:47 +00:00
Antonin Godard
adc323dd4d dev-manual: document how to provide confs from layer.conf
Add a section on providing global level configuration from the
layer.conf file. Since this file is parsed at an earlier stage in the
parsing process, it's not possible to combine bb.utils.contains and
{DISTRO,MACHINE}_FEATURES to conditionally set some configurations.

This patch documents:

- First that this file can be used for providing such configuration.
- Then demonstrate how to conditionally provide them, using a technique
  that is currently used in meta-virtualization
  (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50).

Fixes [YOCTO #12688].

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: cc3fa1b0e51377f4e03eaa1ca60c2f2ee0cd917e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-15 11:16:58 +00:00
Michael Opdenacker
a738448d83 manuals: remove tab characters
As reported by "make sphinx-lint"

Tabs are even removed in Makefile examples,
as Sphinx turns them to spaces anyway in the generated output.

(From yocto-docs rev: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-12 17:29:34 +01:00
Michael Opdenacker
e426fd7f86 manuals: fix incorrect double backticks
As reported by "make sphinx-lint"

(From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
025386d53c manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.

In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.

In some cases too, completely remove the sentence, when
it's redundant with the preceding title.

(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24 16:13:28 +00:00
Michael Opdenacker
5785754244 dev-manual: layers: update link to YP Compatible form
(From yocto-docs rev: bf69c60b6fafad2497d7c8de51c7e1eb85bcb756)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Megan Knight <megankn@amazon.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-01 17:45:06 +00:00
BELHADJ SALEM Talel
104899f390 dev-manual: layers: Add notes about layer.conf
As discussed before with Richard Purdie, the code supports this but the documentation does not.
Developers in general will not notice this or focus on it because they do not mess with the
layer.conf template file, but in my opinion I think more details can help.

(From yocto-docs rev: 15fc103d4ddd14698c8e75cc654ac157ca1ad740)

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
6846d4d00b manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.

(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.

So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.

(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00