diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:41 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 3240a59758e918afa79d14c961492d6f98cc3d85 (patch) | |
tree | c9a278f665319c0eccd6c3fb5e4133d17b309699 /documentation/ref-manual/ref-variables.rst | |
parent | 11c048fbeae7d3eb12c43bd14953cb64b3de53bd (diff) | |
download | poky-3240a59758e918afa79d14c961492d6f98cc3d85.tar.gz |
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>
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index d98e358173..a8a949b92a 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -1016,7 +1016,7 @@ system and gives an overview of their function and contents. | |||
1016 | (SDK). | 1016 | (SDK). |
1017 | 1017 | ||
1018 | - *task:* Save output file signatures for | 1018 | - *task:* Save output file signatures for |
1019 | :ref:`shared state <overview-manual/overview-manual-concepts:shared state cache>` | 1019 | :ref:`shared state <overview-manual/concepts:shared state cache>` |
1020 | (sstate) tasks. | 1020 | (sstate) tasks. |
1021 | This saves one file per task and lists the SHA-256 checksums for | 1021 | This saves one file per task and lists the SHA-256 checksums for |
1022 | each file staged (i.e. the output of the task). | 1022 | each file staged (i.e. the output of the task). |
@@ -1522,7 +1522,7 @@ system and gives an overview of their function and contents. | |||
1522 | .. note:: | 1522 | .. note:: |
1523 | 1523 | ||
1524 | Tasks that read from or write to this directory should run under | 1524 | Tasks that read from or write to this directory should run under |
1525 | :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. | 1525 | :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`. |
1526 | 1526 | ||
1527 | :term:`DATE` | 1527 | :term:`DATE` |
1528 | The date the build was started. Dates appear using the year, month, | 1528 | 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. | |||
1641 | - One recipe having another recipe in ``DEPENDS`` does not by | 1641 | - One recipe having another recipe in ``DEPENDS`` does not by |
1642 | itself add any runtime dependencies between the packages | 1642 | itself add any runtime dependencies between the packages |
1643 | produced by the two recipes. However, as explained in the | 1643 | produced by the two recipes. However, as explained in the |
1644 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 1644 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
1645 | section in the Yocto Project Overview and Concepts Manual, | 1645 | section in the Yocto Project Overview and Concepts Manual, |
1646 | runtime dependencies will often be added automatically, meaning | 1646 | runtime dependencies will often be added automatically, meaning |
1647 | ``DEPENDS`` alone is sufficient for most recipes. | 1647 | ``DEPENDS`` alone is sufficient for most recipes. |
@@ -1672,9 +1672,9 @@ system and gives an overview of their function and contents. | |||
1672 | For more information on the structure of the Build Directory, see | 1672 | For more information on the structure of the Build Directory, see |
1673 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. | 1673 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. |
1674 | For more detail on the contents of the ``deploy`` directory, see the | 1674 | For more detail on the contents of the ``deploy`` directory, see the |
1675 | ":ref:`overview-manual/overview-manual-concepts:images`", | 1675 | ":ref:`overview-manual/concepts:images`", |
1676 | ":ref:`overview-manual/overview-manual-concepts:package feeds`", and | 1676 | ":ref:`overview-manual/concepts:package feeds`", and |
1677 | ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections all in the | 1677 | ":ref:`overview-manual/concepts:application development sdk`" sections all in the |
1678 | Yocto Project Overview and Concepts Manual. | 1678 | Yocto Project Overview and Concepts Manual. |
1679 | 1679 | ||
1680 | :term:`DEPLOY_DIR_DEB` | 1680 | :term:`DEPLOY_DIR_DEB` |
@@ -1696,7 +1696,7 @@ system and gives an overview of their function and contents. | |||
1696 | :ref:`ref-tasks-package_write_deb` task | 1696 | :ref:`ref-tasks-package_write_deb` task |
1697 | writes Debian packages into the appropriate folder. For more | 1697 | writes Debian packages into the appropriate folder. For more |
1698 | information on how packaging works, see the | 1698 | information on how packaging works, see the |
1699 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section | 1699 | ":ref:`overview-manual/concepts:package feeds`" section |
1700 | in the Yocto Project Overview and Concepts Manual. | 1700 | in the Yocto Project Overview and Concepts Manual. |
1701 | 1701 | ||
1702 | :term:`DEPLOY_DIR_IMAGE` | 1702 | :term:`DEPLOY_DIR_IMAGE` |
@@ -1710,8 +1710,8 @@ system and gives an overview of their function and contents. | |||
1710 | For more information on the structure of the Build Directory, see | 1710 | For more information on the structure of the Build Directory, see |
1711 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. | 1711 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. |
1712 | For more detail on the contents of the ``deploy`` directory, see the | 1712 | For more detail on the contents of the ``deploy`` directory, see the |
1713 | ":ref:`overview-manual/overview-manual-concepts:images`" and | 1713 | ":ref:`overview-manual/concepts:images`" and |
1714 | ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections both in | 1714 | ":ref:`overview-manual/concepts:application development sdk`" sections both in |
1715 | the Yocto Project Overview and Concepts Manual. | 1715 | the Yocto Project Overview and Concepts Manual. |
1716 | 1716 | ||
1717 | :term:`DEPLOY_DIR_IPK` | 1717 | :term:`DEPLOY_DIR_IPK` |
@@ -1732,7 +1732,7 @@ system and gives an overview of their function and contents. | |||
1732 | :ref:`ref-tasks-package_write_ipk` task | 1732 | :ref:`ref-tasks-package_write_ipk` task |
1733 | writes IPK packages into the appropriate folder. For more information | 1733 | writes IPK packages into the appropriate folder. For more information |
1734 | on how packaging works, see the | 1734 | on how packaging works, see the |
1735 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section | 1735 | ":ref:`overview-manual/concepts:package feeds`" section |
1736 | in the Yocto Project Overview and Concepts Manual. | 1736 | in the Yocto Project Overview and Concepts Manual. |
1737 | 1737 | ||
1738 | :term:`DEPLOY_DIR_RPM` | 1738 | :term:`DEPLOY_DIR_RPM` |
@@ -1753,7 +1753,7 @@ system and gives an overview of their function and contents. | |||
1753 | :ref:`ref-tasks-package_write_rpm` task | 1753 | :ref:`ref-tasks-package_write_rpm` task |
1754 | writes RPM packages into the appropriate folder. For more information | 1754 | writes RPM packages into the appropriate folder. For more information |
1755 | on how packaging works, see the | 1755 | on how packaging works, see the |
1756 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section | 1756 | ":ref:`overview-manual/concepts:package feeds`" section |
1757 | in the Yocto Project Overview and Concepts Manual. | 1757 | in the Yocto Project Overview and Concepts Manual. |
1758 | 1758 | ||
1759 | :term:`DEPLOY_DIR_TAR` | 1759 | :term:`DEPLOY_DIR_TAR` |
@@ -1774,7 +1774,7 @@ system and gives an overview of their function and contents. | |||
1774 | :ref:`ref-tasks-package_write_tar` task | 1774 | :ref:`ref-tasks-package_write_tar` task |
1775 | writes TAR packages into the appropriate folder. For more information | 1775 | writes TAR packages into the appropriate folder. For more information |
1776 | on how packaging works, see the | 1776 | on how packaging works, see the |
1777 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section | 1777 | ":ref:`overview-manual/concepts:package feeds`" section |
1778 | in the Yocto Project Overview and Concepts Manual. | 1778 | in the Yocto Project Overview and Concepts Manual. |
1779 | 1779 | ||
1780 | :term:`DEPLOYDIR` | 1780 | :term:`DEPLOYDIR` |
@@ -2419,7 +2419,7 @@ system and gives an overview of their function and contents. | |||
2419 | 2419 | ||
2420 | The previous statement appears in the | 2420 | The previous statement appears in the |
2421 | ``linux-yocto-dev.bbappend`` file, which is found in the | 2421 | ``linux-yocto-dev.bbappend`` file, which is found in the |
2422 | :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` in | 2422 | :ref:`overview-manual/development-environment:yocto project source repositories` in |
2423 | ``meta-intel/common/recipes-kernel/linux``. Here, the machine | 2423 | ``meta-intel/common/recipes-kernel/linux``. Here, the machine |
2424 | override is a special :term:`PACKAGE_ARCH` | 2424 | override is a special :term:`PACKAGE_ARCH` |
2425 | definition for multiple ``meta-intel`` machines. | 2425 | definition for multiple ``meta-intel`` machines. |
@@ -2509,7 +2509,7 @@ system and gives an overview of their function and contents. | |||
2509 | build system uses files from ``files/defconfig``. | 2509 | build system uses files from ``files/defconfig``. |
2510 | 2510 | ||
2511 | You can find out more about the patching process in the | 2511 | You can find out more about the patching process in the |
2512 | ":ref:`overview-manual/overview-manual-concepts:patching`" section | 2512 | ":ref:`overview-manual/concepts:patching`" section |
2513 | in the Yocto Project Overview and Concepts Manual and the | 2513 | in the Yocto Project Overview and Concepts Manual and the |
2514 | ":ref:`dev-manual/common-tasks:patching code`" section in | 2514 | ":ref:`dev-manual/common-tasks:patching code`" section in |
2515 | the Yocto Project Development Tasks Manual. See the | 2515 | the Yocto Project Development Tasks Manual. See the |
@@ -3126,7 +3126,7 @@ system and gives an overview of their function and contents. | |||
3126 | The location is | 3126 | The location is |
3127 | derived using the :term:`DEPLOY_DIR_IMAGE` | 3127 | derived using the :term:`DEPLOY_DIR_IMAGE` |
3128 | and :term:`IMAGE_NAME` variables. You can find | 3128 | and :term:`IMAGE_NAME` variables. You can find |
3129 | information on how the image is created in the ":ref:`overview-manual/overview-manual-concepts:image generation`" | 3129 | information on how the image is created in the ":ref:`overview-manual/concepts:image generation`" |
3130 | section in the Yocto Project Overview and Concepts Manual. | 3130 | section in the Yocto Project Overview and Concepts Manual. |
3131 | 3131 | ||
3132 | :term:`IMAGE_NAME` | 3132 | :term:`IMAGE_NAME` |
@@ -5578,7 +5578,7 @@ system and gives an overview of their function and contents. | |||
5578 | ${STAGING_DIR_HOST}/pkgdata | 5578 | ${STAGING_DIR_HOST}/pkgdata |
5579 | 5579 | ||
5580 | For examples of how this data is used, see the | 5580 | For examples of how this data is used, see the |
5581 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 5581 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
5582 | section in the Yocto Project Overview and Concepts Manual and the | 5582 | section in the Yocto Project Overview and Concepts Manual and the |
5583 | ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" | 5583 | ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" |
5584 | section in the Yocto Project Development Tasks Manual. For more | 5584 | section in the Yocto Project Development Tasks Manual. For more |
@@ -5691,9 +5691,9 @@ system and gives an overview of their function and contents. | |||
5691 | 5691 | ||
5692 | The OpenEmbedded build system does not need the aid of ``PR`` | 5692 | The OpenEmbedded build system does not need the aid of ``PR`` |
5693 | to know when to rebuild a recipe. The build system uses the task | 5693 | to know when to rebuild a recipe. The build system uses the task |
5694 | :ref:`input checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` along with the | 5694 | :ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the |
5695 | :ref:`stamp <structure-build-tmp-stamps>` and | 5695 | :ref:`stamp <structure-build-tmp-stamps>` and |
5696 | :ref:`overview-manual/overview-manual-concepts:shared state cache` | 5696 | :ref:`overview-manual/concepts:shared state cache` |
5697 | mechanisms. | 5697 | mechanisms. |
5698 | 5698 | ||
5699 | The ``PR`` variable primarily becomes significant when a package | 5699 | The ``PR`` variable primarily becomes significant when a package |
@@ -5875,7 +5875,7 @@ system and gives an overview of their function and contents. | |||
5875 | libplds4.so" | 5875 | libplds4.so" |
5876 | 5876 | ||
5877 | For more information, see the | 5877 | For more information, see the |
5878 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 5878 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
5879 | section in the Yocto Project Overview and Concepts Manual. | 5879 | section in the Yocto Project Overview and Concepts Manual. |
5880 | 5880 | ||
5881 | :term:`PROVIDES` | 5881 | :term:`PROVIDES` |
@@ -6068,7 +6068,7 @@ system and gives an overview of their function and contents. | |||
6068 | runtime dependencies are automatically detected and added. Therefore, | 6068 | runtime dependencies are automatically detected and added. Therefore, |
6069 | most recipes do not need to set ``RDEPENDS``. For more information, | 6069 | most recipes do not need to set ``RDEPENDS``. For more information, |
6070 | see the | 6070 | see the |
6071 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 6071 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
6072 | section in the Yocto Project Overview and Concepts Manual. | 6072 | section in the Yocto Project Overview and Concepts Manual. |
6073 | 6073 | ||
6074 | The practical effect of the above ``RDEPENDS`` assignment is that | 6074 | The practical effect of the above ``RDEPENDS`` assignment is that |
@@ -7023,7 +7023,7 @@ system and gives an overview of their function and contents. | |||
7023 | 7023 | ||
7024 | - ``file://`` - Fetches files, which are usually files shipped | 7024 | - ``file://`` - Fetches files, which are usually files shipped |
7025 | with the :term:`Metadata`, from the local machine (e.g. | 7025 | with the :term:`Metadata`, from the local machine (e.g. |
7026 | :ref:`patch <overview-manual/overview-manual-concepts:patching>` files). | 7026 | :ref:`patch <overview-manual/concepts:patching>` files). |
7027 | The path is relative to the :term:`FILESPATH` | 7027 | The path is relative to the :term:`FILESPATH` |
7028 | variable. Thus, the build system searches, in order, from the | 7028 | variable. Thus, the build system searches, in order, from the |
7029 | following directories, which are assumed to be a subdirectories of | 7029 | following directories, which are assumed to be a subdirectories of |
@@ -7316,7 +7316,7 @@ system and gives an overview of their function and contents. | |||
7316 | see the :ref:`ref-tasks-populate_sysroot` | 7316 | see the :ref:`ref-tasks-populate_sysroot` |
7317 | task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`" | 7317 | task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`" |
7318 | section in the Yocto Project Development Tasks Manual, the | 7318 | section in the Yocto Project Development Tasks Manual, the |
7319 | ":ref:`overview-manual/overview-manual-concepts:configuration, compilation, and staging`" | 7319 | ":ref:`overview-manual/concepts:configuration, compilation, and staging`" |
7320 | section in the Yocto Project Overview and Concepts Manual, and the | 7320 | section in the Yocto Project Overview and Concepts Manual, and the |
7321 | :term:`SYSROOT_DIRS` variable. | 7321 | :term:`SYSROOT_DIRS` variable. |
7322 | 7322 | ||
@@ -7437,7 +7437,7 @@ system and gives an overview of their function and contents. | |||
7437 | 7437 | ||
7438 | For information on how BitBake uses stamp files to determine if a | 7438 | For information on how BitBake uses stamp files to determine if a |
7439 | task should be rerun, see the | 7439 | task should be rerun, see the |
7440 | ":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`" | 7440 | ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" |
7441 | section in the Yocto Project Overview and Concepts Manual. | 7441 | section in the Yocto Project Overview and Concepts Manual. |
7442 | 7442 | ||
7443 | See :term:`STAMPS_DIR`, | 7443 | See :term:`STAMPS_DIR`, |