diff options
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index 2680c6ac2c..415fbf6d69 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | |||
| @@ -900,6 +900,33 @@ definitions:: | |||
| 900 | of include . Doing so makes sure that an error is produced if the file cannot | 900 | of include . Doing so makes sure that an error is produced if the file cannot |
| 901 | be found. | 901 | be found. |
| 902 | 902 | ||
| 903 | ``include_all`` Directive | ||
| 904 | ------------------------- | ||
| 905 | |||
| 906 | The ``include_all`` directive works like the :ref:`include | ||
| 907 | <bitbake-user-manual/bitbake-user-manual-metadata:\`\`include\`\` directive>` | ||
| 908 | directive but will include all of the files that match the specified path in | ||
| 909 | the enabled layers (layers part of :term:`BBLAYERS`). | ||
| 910 | |||
| 911 | For example, let's say a ``maintainers.inc`` file is present in different layers | ||
| 912 | and is conventionally placed in the ``conf/distro/include`` directory of each | ||
| 913 | layer. In that case the ``include_all`` directive can be used to include | ||
| 914 | the ``maintainers.inc`` file for all of these layers:: | ||
| 915 | |||
| 916 | include_all conf/distro/include/maintainers.inc | ||
| 917 | |||
| 918 | In other words, the ``maintainers.inc`` file for each layer is included through | ||
| 919 | the :ref:`include <bitbake-user-manual/bitbake-user-manual-metadata:\`\`include\`\` directive>` | ||
| 920 | directive. | ||
| 921 | |||
| 922 | BitBake will iterate through the colon-separated :term:`BBPATH` list to look for | ||
| 923 | matching files to include, from left to right. As a consequence, matching files | ||
| 924 | are included in that order. | ||
| 925 | |||
| 926 | As the ``include_all`` directive uses the :ref:`include | ||
| 927 | <bitbake-user-manual/bitbake-user-manual-metadata:\`\`include\`\` directive>` | ||
| 928 | directive in the background, no error is produced if no files are matched. | ||
| 929 | |||
| 903 | .. _require-inclusion: | 930 | .. _require-inclusion: |
| 904 | 931 | ||
| 905 | ``require`` Directive | 932 | ``require`` Directive |
