1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 17:19:20 +00:00

overview-manual: remove 'overview-manual' from filenames

All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Nicolas Dechesne
2020-12-03 22:38:41 +01:00
committed by Richard Purdie
parent 11c048fbea
commit 3240a59758
25 changed files with 108 additions and 108 deletions
+1 -1
View File
@@ -198,7 +198,7 @@ and also any configuration information about how that package was
configured and built.
You can find more information on licensing in the
":ref:`overview-manual/overview-manual-development-environment:licensing`"
":ref:`overview-manual/development-environment:licensing`"
section in the Yocto
Project Overview and Concepts Manual and also in the
":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
+1 -1
View File
@@ -26,7 +26,7 @@ QEMU, you should now have these lines in ``local.conf``:
Minimum Git version
-------------------
The minimum :ref:`overview-manual/overview-manual-development-environment:git`
The minimum :ref:`overview-manual/development-environment:git`
version required on the
build host is now 1.7.8 because the ``--list`` option is now required by
BitBake's Git fetcher. As always, if your host distribution does not
+1 -1
View File
@@ -51,7 +51,7 @@ Consider the following:
:term:`SYSROOT_PREPROCESS_FUNCS`.
For an example, see the ``pixbufcache`` class in ``meta/classes/`` in
the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`.
the :ref:`overview-manual/development-environment:yocto project source repositories`.
.. note::
+6 -6
View File
@@ -406,7 +406,7 @@ cross-compilation tools.
The ``cross-canadian`` class provides support for the recipes that build
the Canadian Cross-compilation tools for SDKs. See the
":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`"
":ref:`overview-manual/concepts:cross-development toolchain generation`"
section in the Yocto Project Overview and Concepts Manual for more
discussion on these cross-compilation tools.
@@ -417,7 +417,7 @@ discussion on these cross-compilation tools.
The ``crosssdk`` class provides support for the recipes that build the
cross-compilation tools used for building SDKs. See the
":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`"
":ref:`overview-manual/concepts:cross-development toolchain generation`"
section in the Yocto Project Overview and Concepts Manual for more
discussion on these cross-compilation tools.
@@ -930,7 +930,7 @@ For information on customizing images, see the
":ref:`dev-manual/common-tasks:customizing images`" section
in the Yocto Project Development Tasks Manual. For information on how
images are created, see the
":ref:`overview-manual/overview-manual-concepts:images`" section in the
":ref:`overview-manual/concepts:images`" section in the
Yocto Project Overview and Concpets Manual.
.. _ref-classes-image-buildinfo:
@@ -2039,7 +2039,7 @@ These classes are inherited by and used with the ``populate_sdk_base``
class.
For more information on the cross-development toolchain generation, see
the ":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`"
the ":ref:`overview-manual/concepts:cross-development toolchain generation`"
section in the Yocto Project Overview and Concepts Manual. For
information on advantages gained when building a cross-development
toolchain using the :ref:`ref-tasks-populate_sdk`
@@ -2268,7 +2268,7 @@ The root filesystem is created from packages using one of the
:term:`PACKAGE_CLASSES` variable.
For information on how root filesystem images are created, see the
":ref:`overview-manual/overview-manual-concepts:image generation`"
":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-classes-sanity:
@@ -2375,7 +2375,7 @@ default, the class is enabled through the
:term:`INHERIT_DISTRO` variable's default value.
For more information on sstate, see the
":ref:`overview-manual/overview-manual-concepts:shared state cache`"
":ref:`overview-manual/concepts:shared state cache`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-classes-staging:
@@ -50,7 +50,7 @@ Major Release Codenames
=======================
Each major release receives a codename that identifies the release in
the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`.
the :ref:`overview-manual/development-environment:yocto project source repositories`.
The concept is that branches of :term:`Metadata` with the same
codename are likely to be compatible and thus work together.
+3 -3
View File
@@ -399,8 +399,8 @@ This directory contains any "end result" output from the OpenEmbedded
build process. The :term:`DEPLOY_DIR` variable points
to this directory. For more detail on the contents of the ``deploy``
directory, see the
":ref:`overview-manual/overview-manual-concepts:images`" and
":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections in the Yocto
":ref:`overview-manual/concepts:images`" and
":ref:`overview-manual/concepts:application development sdk`" sections in the Yocto
Project Overview and Concepts Manual.
.. _structure-build-tmp-deploy-deb:
@@ -545,7 +545,7 @@ and timestamps for tracking purposes.
For information on how BitBake uses stamp files to determine if a task
should be rerun, see the
":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`"
":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
section in the Yocto Project Overview and Concepts Manual.
.. _structure-build-tmp-log:
@@ -15,7 +15,7 @@ Yocto Project.
For introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>` and the
":ref:`overview-manual/overview-manual-development-environment:the yocto project development environment`"
":ref:`overview-manual/development-environment:the yocto project development environment`"
chapter in the Yocto Project Overview and Concepts Manual.
If you want to use the Yocto Project to quickly build an image without
+18 -18
View File
@@ -140,7 +140,7 @@ The ``do_image`` task performs pre-processing on the image through the
:term:`IMAGE_PREPROCESS_COMMAND` and
dynamically generates supporting ``do_image_*`` tasks as needed.
For more information on image creation, see the ":ref:`overview-manual/overview-manual-concepts:image generation`"
For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-image-complete:
@@ -159,7 +159,7 @@ through the
:term:`IMAGE_POSTPROCESS_COMMAND`.
For more information on image creation, see the
":ref:`overview-manual/overview-manual-concepts:image generation`"
":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-install:
@@ -174,7 +174,7 @@ compilation directory. The ``do_install`` task, as well as other tasks
that either directly or indirectly depend on the installed files (e.g.
:ref:`ref-tasks-package`, ``do_package_write_*``, and
:ref:`ref-tasks-rootfs`), run under
:ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`.
:ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
.. note::
@@ -218,7 +218,7 @@ The ``do_package`` task, in conjunction with the
:ref:`ref-tasks-packagedata` task, also saves some
important package metadata. For additional information, see the
:term:`PKGDESTWORK` variable and the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_qa:
@@ -237,7 +237,7 @@ see the :ref:`insane <ref-classes-insane>` class.
Creates Debian packages (i.e. ``*.deb`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section in
":ref:`overview-manual/concepts:package feeds`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_ipk:
@@ -248,7 +248,7 @@ the Yocto Project Overview and Concepts Manual.
Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section in
":ref:`overview-manual/concepts:package feeds`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_rpm:
@@ -259,7 +259,7 @@ the Yocto Project Overview and Concepts Manual.
Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section in
":ref:`overview-manual/concepts:package feeds`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_tar:
@@ -270,7 +270,7 @@ the Yocto Project Overview and Concepts Manual.
Creates tarballs and places them in the
``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section in
":ref:`overview-manual/concepts:package feeds`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-packagedata:
@@ -349,7 +349,7 @@ patch files end with either ``.patch`` or ``.diff``, every file would be
applied as a patch by default except for the ``patch_file5`` patch.
You can find out more about the patching process in the
":ref:`overview-manual/overview-manual-concepts:patching`" section in
":ref:`overview-manual/concepts:patching`" section in
the Yocto Project Overview and Concepts Manual and the
":ref:`dev-manual/common-tasks:patching code`" section in the
Yocto Project Development Tasks Manual.
@@ -368,7 +368,7 @@ the image is constructed.
-------------------
Creates the file and directory structure for an installable SDK. See the
":ref:`overview-manual/overview-manual-concepts:sdk generation`"
":ref:`overview-manual/concepts:sdk generation`"
section in the Yocto Project Overview and Concepts Manual for more
information.
@@ -378,7 +378,7 @@ information.
-----------------------
Creates the file and directory structure for an installable extensible
SDK (eSDK). See the ":ref:`overview-manual/overview-manual-concepts:sdk generation`"
SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
section in the Yocto Project Overview and Concepts Manual for more
information.
@@ -434,7 +434,7 @@ Unpacks the source code into a working directory pointed to by
``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
variable also plays a role in where unpacked source files ultimately
reside. For more information on how source files are unpacked, see the
":ref:`overview-manual/overview-manual-concepts:source fetching`"
":ref:`overview-manual/concepts:source fetching`"
section in the Yocto Project Overview and Concepts Manual and also see
the ``WORKDIR`` and ``S`` variable descriptions.
@@ -500,7 +500,7 @@ You can run this task using BitBake as follows:
$ bitbake -c clean recipe
Running this task does not remove the
:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>` cache files.
:ref:`sstate <overview-manual/concepts:shared state cache>` cache files.
Consequently, if no changes have been made and the recipe is rebuilt
after cleaning, output files are simply restored from the sstate cache.
If you want to remove the sstate cache files for the recipe, you need to
@@ -513,7 +513,7 @@ use the :ref:`ref-tasks-cleansstate` task instead
---------------
Removes all output files, shared state
(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, and
(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, and
downloaded source files for a target (i.e. the contents of
:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is
identical to the :ref:`ref-tasks-cleansstate` task
@@ -534,10 +534,10 @@ task.
------------------
Removes all output files and shared state
(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a
(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a
target. Essentially, the ``do_cleansstate`` task is identical to the
:ref:`ref-tasks-clean` task with the added removal of
shared state (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`)
shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`)
cache.
You can run this task using BitBake as follows:
@@ -593,7 +593,7 @@ Lists all defined tasks for a target.
``do_package_index``
--------------------
Creates or updates the index in the :ref:`overview-manual/overview-manual-concepts:package feeds` area.
Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area.
.. note::
@@ -631,7 +631,7 @@ has some more information about these types of images.
-------------
Creates the root filesystem (file and directory structure) for an image.
See the ":ref:`overview-manual/overview-manual-concepts:image generation`"
See the ":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual for more
information on how the root filesystem is created.
+3 -3
View File
@@ -160,7 +160,7 @@ universal, the list includes them just in case:
Creation of these toolchains is simple and automated. For information on
toolchain concepts as they apply to the Yocto Project, see the
":ref:`overview-manual/overview-manual-concepts:Cross-Development
":ref:`overview-manual/concepts:Cross-Development
Toolchain Generation`" section in the Yocto Project Overview and Concepts
Manual. You can also find more information on using the relocatable
toolchain in the :doc:`/sdk-manual/index` manual.
@@ -189,7 +189,7 @@ universal, the list includes them just in case:
layers used within Yocto Project.
For introductory information on layers, see the
":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer
":ref:`overview-manual/yp-intro:The Yocto Project Layer
Model`" section in the Yocto Project Overview and Concepts Manual. For
more detailed information on layers, see the
":ref:`dev-manual/common-tasks:Understanding and Creating
@@ -366,7 +366,7 @@ universal, the list includes them just in case:
For more information on concepts related to Git repositories,
branches, and tags, see the
":ref:`overview-manual/overview-manual-development-environment:repositories, tags, and branches`"
":ref:`overview-manual/development-environment:repositories, tags, and branches`"
section in the Yocto Project Overview and Concepts Manual.
:term:`Task`
+23 -23
View File
@@ -1016,7 +1016,7 @@ system and gives an overview of their function and contents.
(SDK).
- *task:* Save output file signatures for
:ref:`shared state <overview-manual/overview-manual-concepts:shared state cache>`
:ref:`shared state <overview-manual/concepts:shared state cache>`
(sstate) tasks.
This saves one file per task and lists the SHA-256 checksums for
each file staged (i.e. the output of the task).
@@ -1522,7 +1522,7 @@ system and gives an overview of their function and contents.
.. note::
Tasks that read from or write to this directory should run under
:ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`.
:ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
:term:`DATE`
The date the build was started. Dates appear using the year, month,
@@ -1641,7 +1641,7 @@ system and gives an overview of their function and contents.
- One recipe having another recipe in ``DEPENDS`` does not by
itself add any runtime dependencies between the packages
produced by the two recipes. However, as explained in the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual,
runtime dependencies will often be added automatically, meaning
``DEPENDS`` alone is sufficient for most recipes.
@@ -1672,9 +1672,9 @@ system and gives an overview of their function and contents.
For more information on the structure of the Build Directory, see
":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
For more detail on the contents of the ``deploy`` directory, see the
":ref:`overview-manual/overview-manual-concepts:images`",
":ref:`overview-manual/overview-manual-concepts:package feeds`", and
":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections all in the
":ref:`overview-manual/concepts:images`",
":ref:`overview-manual/concepts:package feeds`", and
":ref:`overview-manual/concepts:application development sdk`" sections all in the
Yocto Project Overview and Concepts Manual.
:term:`DEPLOY_DIR_DEB`
@@ -1696,7 +1696,7 @@ system and gives an overview of their function and contents.
:ref:`ref-tasks-package_write_deb` task
writes Debian packages into the appropriate folder. For more
information on how packaging works, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section
":ref:`overview-manual/concepts:package feeds`" section
in the Yocto Project Overview and Concepts Manual.
:term:`DEPLOY_DIR_IMAGE`
@@ -1710,8 +1710,8 @@ system and gives an overview of their function and contents.
For more information on the structure of the Build Directory, see
":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
For more detail on the contents of the ``deploy`` directory, see the
":ref:`overview-manual/overview-manual-concepts:images`" and
":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections both in
":ref:`overview-manual/concepts:images`" and
":ref:`overview-manual/concepts:application development sdk`" sections both in
the Yocto Project Overview and Concepts Manual.
:term:`DEPLOY_DIR_IPK`
@@ -1732,7 +1732,7 @@ system and gives an overview of their function and contents.
:ref:`ref-tasks-package_write_ipk` task
writes IPK packages into the appropriate folder. For more information
on how packaging works, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section
":ref:`overview-manual/concepts:package feeds`" section
in the Yocto Project Overview and Concepts Manual.
:term:`DEPLOY_DIR_RPM`
@@ -1753,7 +1753,7 @@ system and gives an overview of their function and contents.
:ref:`ref-tasks-package_write_rpm` task
writes RPM packages into the appropriate folder. For more information
on how packaging works, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section
":ref:`overview-manual/concepts:package feeds`" section
in the Yocto Project Overview and Concepts Manual.
:term:`DEPLOY_DIR_TAR`
@@ -1774,7 +1774,7 @@ system and gives an overview of their function and contents.
:ref:`ref-tasks-package_write_tar` task
writes TAR packages into the appropriate folder. For more information
on how packaging works, see the
":ref:`overview-manual/overview-manual-concepts:package feeds`" section
":ref:`overview-manual/concepts:package feeds`" section
in the Yocto Project Overview and Concepts Manual.
:term:`DEPLOYDIR`
@@ -2419,7 +2419,7 @@ system and gives an overview of their function and contents.
The previous statement appears in the
``linux-yocto-dev.bbappend`` file, which is found in the
:ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` in
:ref:`overview-manual/development-environment:yocto project source repositories` in
``meta-intel/common/recipes-kernel/linux``. Here, the machine
override is a special :term:`PACKAGE_ARCH`
definition for multiple ``meta-intel`` machines.
@@ -2509,7 +2509,7 @@ system and gives an overview of their function and contents.
build system uses files from ``files/defconfig``.
You can find out more about the patching process in the
":ref:`overview-manual/overview-manual-concepts:patching`" section
":ref:`overview-manual/concepts:patching`" section
in the Yocto Project Overview and Concepts Manual and the
":ref:`dev-manual/common-tasks:patching code`" section in
the Yocto Project Development Tasks Manual. See the
@@ -3126,7 +3126,7 @@ system and gives an overview of their function and contents.
The location is
derived using the :term:`DEPLOY_DIR_IMAGE`
and :term:`IMAGE_NAME` variables. You can find
information on how the image is created in the ":ref:`overview-manual/overview-manual-concepts:image generation`"
information on how the image is created in the ":ref:`overview-manual/concepts:image generation`"
section in the Yocto Project Overview and Concepts Manual.
:term:`IMAGE_NAME`
@@ -5578,7 +5578,7 @@ system and gives an overview of their function and contents.
${STAGING_DIR_HOST}/pkgdata
For examples of how this data is used, see the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual and the
":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``"
section in the Yocto Project Development Tasks Manual. For more
@@ -5691,9 +5691,9 @@ system and gives an overview of their function and contents.
The OpenEmbedded build system does not need the aid of ``PR``
to know when to rebuild a recipe. The build system uses the task
:ref:`input checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` along with the
:ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the
:ref:`stamp <structure-build-tmp-stamps>` and
:ref:`overview-manual/overview-manual-concepts:shared state cache`
:ref:`overview-manual/concepts:shared state cache`
mechanisms.
The ``PR`` variable primarily becomes significant when a package
@@ -5875,7 +5875,7 @@ system and gives an overview of their function and contents.
libplds4.so"
For more information, see the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual.
:term:`PROVIDES`
@@ -6068,7 +6068,7 @@ system and gives an overview of their function and contents.
runtime dependencies are automatically detected and added. Therefore,
most recipes do not need to set ``RDEPENDS``. For more information,
see the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
":ref:`overview-manual/concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual.
The practical effect of the above ``RDEPENDS`` assignment is that
@@ -7023,7 +7023,7 @@ system and gives an overview of their function and contents.
- ``file://`` - Fetches files, which are usually files shipped
with the :term:`Metadata`, from the local machine (e.g.
:ref:`patch <overview-manual/overview-manual-concepts:patching>` files).
:ref:`patch <overview-manual/concepts:patching>` files).
The path is relative to the :term:`FILESPATH`
variable. Thus, the build system searches, in order, from the
following directories, which are assumed to be a subdirectories of
@@ -7316,7 +7316,7 @@ system and gives an overview of their function and contents.
see the :ref:`ref-tasks-populate_sysroot`
task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`"
section in the Yocto Project Development Tasks Manual, the
":ref:`overview-manual/overview-manual-concepts:configuration, compilation, and staging`"
":ref:`overview-manual/concepts:configuration, compilation, and staging`"
section in the Yocto Project Overview and Concepts Manual, and the
:term:`SYSROOT_DIRS` variable.
@@ -7437,7 +7437,7 @@ system and gives an overview of their function and contents.
For information on how BitBake uses stamp files to determine if a
task should be rerun, see the
":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`"
":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
section in the Yocto Project Overview and Concepts Manual.
See :term:`STAMPS_DIR`,