summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-20 13:16:36 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-12-28 10:57:47 +0000
commitd6e3e5c00d4be7760a81a777be3efe74d870586a (patch)
treec14246ecc618b585af38b0f7d8de0e4c2c5b89bd
parentabef9b08dc1e8de7c4088d982641a2784b98f378 (diff)
downloadpoky-d6e3e5c00d4be7760a81a777be3efe74d870586a.tar.gz
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>
-rw-r--r--documentation/dev-manual/layers.rst22
-rw-r--r--documentation/ref-manual/variables.rst18
2 files changed, 17 insertions, 23 deletions
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 89c8466933..c649e2bd60 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -470,11 +470,23 @@ corresponding recipe file. For example, the append file
470means the original recipe and append filenames are version 470means the original recipe and append filenames are version
471number-specific. If the corresponding recipe is renamed to update to a 471number-specific. If the corresponding recipe is renamed to update to a
472newer version, you must also rename and possibly update the 472newer version, you must also rename and possibly update the
473corresponding ``.bbappend`` as well. During the build process, BitBake 473corresponding ``.bbappend`` as well.
474displays an error on starting if it detects a ``.bbappend`` file that 474
475does not have a corresponding recipe with a matching name. See the 475During the build process, BitBake displays an error on startup if it detects a
476:term:`BB_DANGLINGAPPENDS_WARNONLY` 476``.bbappend`` file that does not have a corresponding recipe with a matching
477variable for information on how to handle this error. 477name. To handle these errors, the best practice is to rename the ``.bbappend``
478to match the original recipe version. This also gives you the opportunity to see
479if the ``.bbappend`` is still relevant for the new version of the recipe.
480
481Another method it to use the character ``%`` in the ``.bbappend`` filename. For
482example, to append information to every ``6.*`` minor versions of the recipe
483``someapp``, the ``someapp_6.%.bbappend`` file can be created. This way, an
484error will only be triggered if the ``someapp`` recipe has a major version
485update.
486
487Finally, another method to deal with these errors is to use the variable
488:term:`BBMASK`, especially in cases where modifying the ``.bbappend`` is not
489possible.
478 490
479Overlaying a File Using Your Layer 491Overlaying a File Using Your Layer
480---------------------------------- 492----------------------------------
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5d24e80865..5c2920603f 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -361,24 +361,6 @@ system and gives an overview of their function and contents.
361 :term:`BB_CURRENTTASK` 361 :term:`BB_CURRENTTASK`
362 See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual. 362 See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual.
363 363
364 :term:`BB_DANGLINGAPPENDS_WARNONLY`
365 Defines how BitBake handles situations where an append file
366 (``.bbappend``) has no corresponding recipe file (``.bb``). This
367 condition often occurs when layers get out of sync (e.g. ``oe-core``
368 bumps a recipe version and the old recipe no longer exists and the
369 other layer has not been updated to the new version of the recipe
370 yet).
371
372 The default fatal behavior is safest because it is the sane reaction
373 given something is out of sync. It is important to realize when your
374 changes are no longer being applied.
375
376 You can change the default behavior by setting this variable to "1",
377 "yes", or "true" in your ``local.conf`` file, which is located in the
378 :term:`Build Directory`: Here is an example::
379
380 BB_DANGLINGAPPENDS_WARNONLY = "1"
381
382 :term:`BB_DEFAULT_TASK` 364 :term:`BB_DEFAULT_TASK`
383 See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual. 365 See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual.
384 366