diff options
-rw-r--r-- | documentation/dev-manual/layers.rst | 22 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 18 |
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 | |||
470 | means the original recipe and append filenames are version | 470 | means the original recipe and append filenames are version |
471 | number-specific. If the corresponding recipe is renamed to update to a | 471 | number-specific. If the corresponding recipe is renamed to update to a |
472 | newer version, you must also rename and possibly update the | 472 | newer version, you must also rename and possibly update the |
473 | corresponding ``.bbappend`` as well. During the build process, BitBake | 473 | corresponding ``.bbappend`` as well. |
474 | displays an error on starting if it detects a ``.bbappend`` file that | 474 | |
475 | does not have a corresponding recipe with a matching name. See the | 475 | During 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 |
477 | variable for information on how to handle this error. | 477 | name. To handle these errors, the best practice is to rename the ``.bbappend`` |
478 | to match the original recipe version. This also gives you the opportunity to see | ||
479 | if the ``.bbappend`` is still relevant for the new version of the recipe. | ||
480 | |||
481 | Another method it to use the character ``%`` in the ``.bbappend`` filename. For | ||
482 | example, to append information to every ``6.*`` minor versions of the recipe | ||
483 | ``someapp``, the ``someapp_6.%.bbappend`` file can be created. This way, an | ||
484 | error will only be triggered if the ``someapp`` recipe has a major version | ||
485 | update. | ||
486 | |||
487 | Finally, another method to deal with these errors is to use the variable | ||
488 | :term:`BBMASK`, especially in cases where modifying the ``.bbappend`` is not | ||
489 | possible. | ||
478 | 490 | ||
479 | Overlaying a File Using Your Layer | 491 | Overlaying 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 | ||