diff options
| -rw-r--r-- | documentation/dev-manual/layers.rst | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 4224a02b28..cc7103ba61 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst | |||
| @@ -392,12 +392,17 @@ These machines are the ones present in your BSP layer, in the ``conf/machine/`` | |||
| 392 | directory. | 392 | directory. |
| 393 | 393 | ||
| 394 | Entering the command causes the script to determine the type of layer | 394 | Entering the command causes the script to determine the type of layer |
| 395 | and then to execute a set of specific tests against the layer. The | 395 | and then to execute a set of specific tests against the layer. |
| 396 | following list overviews the test: | 396 | |
| 397 | The following list overviews the test: | ||
| 397 | 398 | ||
| 398 | - ``common.test_readme``: Tests if a ``README`` file exists in the | 399 | - ``common.test_readme``: Tests if a ``README`` file exists in the |
| 399 | layer and the file is not empty. | 400 | layer and the file is not empty. |
| 400 | 401 | ||
| 402 | - ``common.test_security``: Tests that the layer has a ``SECURITY.md`` | ||
| 403 | (or similar) file, either in the layer itself or at the top of the containing | ||
| 404 | git repository. | ||
| 405 | |||
| 401 | - ``common.test_parse``: Tests to make sure that BitBake can parse the | 406 | - ``common.test_parse``: Tests to make sure that BitBake can parse the |
| 402 | files without error (i.e. ``bitbake -p``). | 407 | files without error (i.e. ``bitbake -p``). |
| 403 | 408 | ||
| @@ -406,6 +411,13 @@ following list overviews the test: | |||
| 406 | 411 | ||
| 407 | - ``common.test_world``: Verifies that ``bitbake world`` works. | 412 | - ``common.test_world``: Verifies that ``bitbake world`` works. |
| 408 | 413 | ||
| 414 | - ``common.test_world_inherit_class``: Verifies that ``bitbake world`` works | ||
| 415 | when the :ref:`ref-classes-yocto-check-layer` class is inherited. | ||
| 416 | |||
| 417 | - ``common.test_patches_upstream_status``: Verifies that all the patch files | ||
| 418 | included in the layer contain a | ||
| 419 | :ref:`contributor-guide/recipe-style-guide:Patch Upstream Status`. | ||
| 420 | |||
| 409 | - ``common.test_signatures``: Tests to be sure that BSP and DISTRO | 421 | - ``common.test_signatures``: Tests to be sure that BSP and DISTRO |
| 410 | layers do not come with recipes that change signatures. | 422 | layers do not come with recipes that change signatures. |
| 411 | 423 | ||
| @@ -431,6 +443,10 @@ following list overviews the test: | |||
| 431 | - ``distro.test_distro_no_set_distros``: Tests to ensure a DISTRO layer | 443 | - ``distro.test_distro_no_set_distros``: Tests to ensure a DISTRO layer |
| 432 | does not set the distribution when the layer is added. | 444 | does not set the distribution when the layer is added. |
| 433 | 445 | ||
| 446 | For a complete list of tests, see the :oe_git:`scripts/lib/checklayer/cases | ||
| 447 | </openembedded-core/tree/scripts/lib/checklayer/cases>` directory in | ||
| 448 | :term:`OpenEmbedded-Core (OE-Core)`. | ||
| 449 | |||
| 434 | Enabling Your Layer | 450 | Enabling Your Layer |
| 435 | =================== | 451 | =================== |
| 436 | 452 | ||
