diff options
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/structure.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 3 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 44 | ||||
-rw-r--r-- | documentation/ref-manual/yocto-project-supported-features.rst | 3 |
4 files changed, 35 insertions, 17 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 2190f5b90e..d6dbb29401 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -611,7 +611,7 @@ example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` | |||
611 | built within the Yocto Project. For this package, a work directory of | 611 | built within the Yocto Project. For this package, a work directory of |
612 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred | 612 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred |
613 | to as the :term:`WORKDIR`, is created. Within this directory, the source is | 613 | to as the :term:`WORKDIR`, is created. Within this directory, the source is |
614 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. | 614 | unpacked to ``sources/linux-qemux86-standard-build`` and then patched by Quilt. |
615 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in | 615 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in |
616 | the Yocto Project Development Tasks Manual for more information.) Within | 616 | the Yocto Project Development Tasks Manual for more information.) Within |
617 | the ``linux-qemux86-standard-build`` directory, standard Quilt | 617 | the ``linux-qemux86-standard-build`` directory, standard Quilt |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index d85d1151f0..e379c424d8 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -412,8 +412,7 @@ them. You can learn more by looking at the | |||
412 | ------------- | 412 | ------------- |
413 | 413 | ||
414 | Unpacks the source code into a working directory pointed to by | 414 | Unpacks the source code into a working directory pointed to by |
415 | ``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify | 415 | ``${``\ :term:`UNPACKDIR`\ ``}``. |
416 | this directory is through the :term:`S` and :term:`WORKDIR` variables. | ||
417 | For more information on how source files are unpacked, see the | 416 | For more information on how source files are unpacked, see the |
418 | ":ref:`overview-manual/concepts:source fetching`" | 417 | ":ref:`overview-manual/concepts:source fetching`" |
419 | section in the Yocto Project Overview and Concepts Manual. | 418 | section in the Yocto Project Overview and Concepts Manual. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c6ae3fb8bc..c56418e2a2 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -265,7 +265,7 @@ system and gives an overview of their function and contents. | |||
265 | build process. By default, this directory is the same as the | 265 | build process. By default, this directory is the same as the |
266 | :term:`S` directory, which is defined as:: | 266 | :term:`S` directory, which is defined as:: |
267 | 267 | ||
268 | S = "${WORKDIR}/${BP}" | 268 | S = "${UNPACKDIR}/${BP}" |
269 | 269 | ||
270 | You can separate the (:term:`S`) directory and the directory pointed to | 270 | You can separate the (:term:`S`) directory and the directory pointed to |
271 | by the :term:`B` variable. Most Autotools-based recipes support | 271 | by the :term:`B` variable. Most Autotools-based recipes support |
@@ -560,6 +560,13 @@ system and gives an overview of their function and contents. | |||
560 | :term:`BB_GENERATE_SHALLOW_TARBALLS` | 560 | :term:`BB_GENERATE_SHALLOW_TARBALLS` |
561 | See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual. | 561 | See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual. |
562 | 562 | ||
563 | :term:`BB_GIT_DEFAULT_DESTSUFFIX` | ||
564 | See :term:`bitbake:BB_GIT_DEFAULT_DESTSUFFIX` in the BitBake manual. | ||
565 | |||
566 | In :term:`OpenEmbedded-Core (OE-Core)`, this variable is set to | ||
567 | :term:`BP` by default in :oe_git:`bitbake.conf | ||
568 | </openembedded-core/tree/meta/conf/bitbake.conf>`. | ||
569 | |||
563 | :term:`BB_GIT_SHALLOW` | 570 | :term:`BB_GIT_SHALLOW` |
564 | See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual. | 571 | See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual. |
565 | 572 | ||
@@ -5350,6 +5357,27 @@ system and gives an overview of their function and contents. | |||
5350 | the :term:`KERNEL_PATH` variable. Both variables are common variables | 5357 | the :term:`KERNEL_PATH` variable. Both variables are common variables |
5351 | used by external Makefiles to point to the kernel source directory. | 5358 | used by external Makefiles to point to the kernel source directory. |
5352 | 5359 | ||
5360 | :term:`KERNEL_SPLIT_MODULES` | ||
5361 | When inheriting the :ref:`ref-classes-kernel-module-split` class, this | ||
5362 | variable controls whether kernel modules are split into separate packages | ||
5363 | or bundled into a single package. | ||
5364 | |||
5365 | For some use cases, a monolithic kernel module package | ||
5366 | :term:`KERNEL_PACKAGE_NAME` that contains all modules built from the | ||
5367 | kernel sources may be preferred to speed up the installation. | ||
5368 | |||
5369 | By default, this variable is set to ``1``, resulting in one package per | ||
5370 | module. Setting it to any other value will generate a single monolithic | ||
5371 | package containing all kernel modules. | ||
5372 | |||
5373 | .. note:: | ||
5374 | |||
5375 | If :term:`KERNEL_SPLIT_MODULES` is set to 0, it is still possible to | ||
5376 | install all kernel modules at once by adding ``kernel-modules`` (assuming | ||
5377 | :term:`KERNEL_PACKAGE_NAME` is ``kernel-modules``) to :term:`IMAGE_INSTALL`. | ||
5378 | The way it works is that a placeholder "kernel-modules" package will be | ||
5379 | created and will depend on every other individual kernel module packages. | ||
5380 | |||
5353 | :term:`KERNEL_SRC` | 5381 | :term:`KERNEL_SRC` |
5354 | The location of the kernel sources. This variable is set to the value | 5382 | The location of the kernel sources. This variable is set to the value |
5355 | of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` | 5383 | of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` |
@@ -8039,7 +8067,7 @@ system and gives an overview of their function and contents. | |||
8039 | :term:`S` | 8067 | :term:`S` |
8040 | The location in the :term:`Build Directory` where | 8068 | The location in the :term:`Build Directory` where |
8041 | unpacked recipe source code resides. By default, this directory is | 8069 | unpacked recipe source code resides. By default, this directory is |
8042 | ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, | 8070 | ``${``\ :term:`UNPACKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, |
8043 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe | 8071 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe |
8044 | version. If the source tarball extracts the code to a directory named | 8072 | version. If the source tarball extracts the code to a directory named |
8045 | anything other than ``${BPN}-${PV}``, or if the source code is | 8073 | anything other than ``${BPN}-${PV}``, or if the source code is |
@@ -8052,19 +8080,10 @@ system and gives an overview of their function and contents. | |||
8052 | ``poky/build``. In this case, the work directory the build system | 8080 | ``poky/build``. In this case, the work directory the build system |
8053 | uses to keep the unpacked recipe for ``db`` is the following:: | 8081 | uses to keep the unpacked recipe for ``db`` is the following:: |
8054 | 8082 | ||
8055 | poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 | 8083 | poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/sources/db-5.1.19 |
8056 | 8084 | ||
8057 | The unpacked source code resides in the ``db-5.1.19`` folder. | 8085 | The unpacked source code resides in the ``db-5.1.19`` folder. |
8058 | 8086 | ||
8059 | This next example assumes a Git repository. By default, Git | ||
8060 | repositories are cloned to ``${WORKDIR}/git`` during | ||
8061 | :ref:`ref-tasks-fetch`. Since this path is different | ||
8062 | from the default value of :term:`S`, you must set it specifically so the | ||
8063 | source can be located:: | ||
8064 | |||
8065 | SRC_URI = "git://path/to/repo.git;branch=main" | ||
8066 | S = "${WORKDIR}/git" | ||
8067 | |||
8068 | :term:`SANITY_REQUIRED_UTILITIES` | 8087 | :term:`SANITY_REQUIRED_UTILITIES` |
8069 | Specifies a list of command-line utilities that should be checked for | 8088 | Specifies a list of command-line utilities that should be checked for |
8070 | during the initial sanity checking process when running BitBake. If | 8089 | during the initial sanity checking process when running BitBake. If |
@@ -8439,7 +8458,6 @@ system and gives an overview of their function and contents. | |||
8439 | sources are fetched from a Git repository and ``setup.py`` is in a | 8458 | sources are fetched from a Git repository and ``setup.py`` is in a |
8440 | ``python/pythonmodule`` subdirectory, you would have this:: | 8459 | ``python/pythonmodule`` subdirectory, you would have this:: |
8441 | 8460 | ||
8442 | S = "${WORKDIR}/git" | ||
8443 | SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" | 8461 | SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" |
8444 | 8462 | ||
8445 | :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` | 8463 | :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` |
diff --git a/documentation/ref-manual/yocto-project-supported-features.rst b/documentation/ref-manual/yocto-project-supported-features.rst index 06e298cbe5..283c79d4cc 100644 --- a/documentation/ref-manual/yocto-project-supported-features.rst +++ b/documentation/ref-manual/yocto-project-supported-features.rst | |||
@@ -209,7 +209,8 @@ builder(s): | |||
209 | - Builder(s) | 209 | - Builder(s) |
210 | * - :wikipedia:`PowerPC (32-bit) <PowerPC>` | 210 | * - :wikipedia:`PowerPC (32-bit) <PowerPC>` |
211 | - PowerPC architecture testing (32-bit) | 211 | - PowerPC architecture testing (32-bit) |
212 | - TBD | 212 | - Peter Marko, |
213 | Adrian Freihofer | ||
213 | - qemuppc, | 214 | - qemuppc, |
214 | qemuppc-tc | 215 | qemuppc-tc |
215 | * - :oe_git:`meta-openembedded </meta-openembedded>` | 216 | * - :oe_git:`meta-openembedded </meta-openembedded>` |