diff options
author | Quentin Schulz <foss@0leil.net> | 2020-09-17 01:59:03 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:36 +0100 |
commit | 89b546f636b246985a7fe1c09779809327b96079 (patch) | |
tree | 055ed2f1b2e2c67a87c14614de2da002ed4eebe0 /documentation/overview-manual/overview-manual-concepts.rst | |
parent | 177aee09fec494e8827a03cc98ba989f4acd459d (diff) | |
download | poky-89b546f636b246985a7fe1c09779809327b96079.tar.gz |
sphinx: "highlight" some variables, tasks or files
(From yocto-docs rev: 41e379dc32e52cec652a7f89caf4c3fd96dd2dda)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-concepts.rst')
-rw-r--r-- | documentation/overview-manual/overview-manual-concepts.rst | 79 |
1 files changed, 24 insertions, 55 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index 9bd02a7001..08d640a5bc 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst | |||
@@ -278,7 +278,7 @@ development environment. | |||
278 | The | 278 | The |
279 | scripts/oe-setup-builddir | 279 | scripts/oe-setup-builddir |
280 | script uses the | 280 | script uses the |
281 | $TEMPLATECONF | 281 | ``$TEMPLATECONF`` |
282 | variable to determine which sample configuration files to locate. | 282 | variable to determine which sample configuration files to locate. |
283 | 283 | ||
284 | The ``local.conf`` file provides many basic variables that define a | 284 | The ``local.conf`` file provides many basic variables that define a |
@@ -620,8 +620,7 @@ module. | |||
620 | For information on how to have the OpenEmbedded build system generate | 620 | For information on how to have the OpenEmbedded build system generate |
621 | tarballs for Git repositories and place them in the | 621 | tarballs for Git repositories and place them in the |
622 | DL_DIR | 622 | DL_DIR |
623 | directory, see the | 623 | directory, see the :term:`BB_GENERATE_MIRROR_TARBALLS` |
624 | BB_GENERATE_MIRROR_TARBALLS | ||
625 | variable in the Yocto Project Reference Manual. | 624 | variable in the Yocto Project Reference Manual. |
626 | 625 | ||
627 | When fetching a repository, BitBake uses the | 626 | When fetching a repository, BitBake uses the |
@@ -1243,9 +1242,9 @@ usually made available in the form of a shared state (sstate) cache. | |||
1243 | .. note:: | 1242 | .. note:: |
1244 | 1243 | ||
1245 | For information on variables affecting sstate, see the | 1244 | For information on variables affecting sstate, see the |
1246 | SSTATE_DIR | 1245 | :term:`SSTATE_DIR` |
1247 | and | 1246 | and |
1248 | SSTATE_MIRRORS | 1247 | :term:`SSTATE_MIRRORS` |
1249 | variables. | 1248 | variables. |
1250 | 1249 | ||
1251 | The idea of a setscene task (i.e ``do_``\ taskname\ ``_setscene``) is a | 1250 | The idea of a setscene task (i.e ``do_``\ taskname\ ``_setscene``) is a |
@@ -1916,25 +1915,15 @@ The following list explains the previous example: | |||
1916 | 1915 | ||
1917 | .. note:: | 1916 | .. note:: |
1918 | 1917 | ||
1919 | If | 1918 | If ``do_deploy`` is not already in the shared state cache or if its input |
1920 | do_deploy | 1919 | checksum (signature) has changed from when the output was cached, the task |
1921 | is not already in the shared state cache or if its input checksum | 1920 | runs to populate the shared state cache, after which the contents of the |
1922 | (signature) has changed from when the output was cached, the task | 1921 | shared state cache is copied to ${:term:`DEPLOY_DIR_IMAGE`}. If |
1923 | runs to populate the shared state cache, after which the contents | 1922 | ``do_deploy`` is in the shared state cache and its signature indicates |
1924 | of the shared state cache is copied to | 1923 | that the cached output is still valid (i.e. if no relevant task inputs |
1925 | ${DEPLOY_DIR_IMAGE} | 1924 | have changed), then the contents of the shared state cache copies |
1926 | . If | 1925 | directly to ${``DEPLOY_DIR_IMAGE``} by the ``do_deploy_setscene`` task |
1927 | do_deploy | 1926 | instead, skipping the ``do_deploy`` task. |
1928 | is in the shared state cache and its signature indicates that the | ||
1929 | cached output is still valid (i.e. if no relevant task inputs have | ||
1930 | changed), then the contents of the shared state cache copies | ||
1931 | directly to | ||
1932 | ${DEPLOY_DIR_IMAGE} | ||
1933 | by the | ||
1934 | do_deploy_setscene | ||
1935 | task instead, skipping the | ||
1936 | do_deploy | ||
1937 | task. | ||
1938 | 1927 | ||
1939 | - The following task definition is glue logic needed to make the | 1928 | - The following task definition is glue logic needed to make the |
1940 | previous settings effective: | 1929 | previous settings effective: |
@@ -1961,18 +1950,9 @@ The following list explains the previous example: | |||
1961 | 1950 | ||
1962 | .. note:: | 1951 | .. note:: |
1963 | 1952 | ||
1964 | In cases where | 1953 | In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be |
1965 | sstate-inputdirs | 1954 | the same, you can use ``sstate-plaindirs``. For example, to preserve the |
1966 | and | 1955 | ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the ``do_package`` |
1967 | sstate-outputdirs | ||
1968 | would be the same, you can use | ||
1969 | sstate-plaindirs | ||
1970 | . For example, to preserve the | ||
1971 | ${PKGD} | ||
1972 | and | ||
1973 | ${PKGDEST} | ||
1974 | output from the | ||
1975 | do_package | ||
1976 | task, use the following: | 1956 | task, use the following: |
1977 | :: | 1957 | :: |
1978 | 1958 | ||
@@ -2016,14 +1996,11 @@ shared state files. Here is an example: | |||
2016 | 1996 | ||
2017 | .. note:: | 1997 | .. note:: |
2018 | 1998 | ||
2019 | The shared state directory ( | 1999 | The shared state directory (``SSTATE_DIR``) is organized into two-character |
2020 | SSTATE_DIR | 2000 | subdirectories, where the subdirectory names are based on the first two |
2021 | ) is organized into two-character subdirectories, where the | 2001 | characters of the hash. |
2022 | subdirectory names are based on the first two characters of the hash. | 2002 | If the shared state directory structure for a mirror has the same structure |
2023 | If the shared state directory structure for a mirror has the same | 2003 | as ``SSTATE_DIR``, you must specify "PATH" as part of the URI to enable the build |
2024 | structure as | ||
2025 | SSTATE_DIR | ||
2026 | , you must specify "PATH" as part of the URI to enable the build | ||
2027 | system to map to the appropriate subdirectory. | 2004 | system to map to the appropriate subdirectory. |
2028 | 2005 | ||
2029 | The shared state package validity can be detected just by looking at the | 2006 | The shared state package validity can be detected just by looking at the |
@@ -2129,17 +2106,9 @@ dependencies, you must manually declare the dependencies. | |||
2129 | 2106 | ||
2130 | .. note:: | 2107 | .. note:: |
2131 | 2108 | ||
2132 | By default, | 2109 | By default, ``foo-dev`` also has an ``RDEPENDS``-style dependency on |
2133 | foo-dev | 2110 | ``foo``, because the default value of ``RDEPENDS_${PN}-dev`` (set in |
2134 | also has an | 2111 | bitbake.conf) includes "${PN}". |
2135 | RDEPENDS | ||
2136 | -style dependency on | ||
2137 | foo | ||
2138 | , because the default value of | ||
2139 | RDEPENDS_${PN}-dev | ||
2140 | (set in | ||
2141 | bitbake.conf | ||
2142 | ) includes "${PN}". | ||
2143 | 2112 | ||
2144 | To ensure that the dependency chain is never broken, ``-dev`` and | 2113 | To ensure that the dependency chain is never broken, ``-dev`` and |
2145 | ``-dbg`` packages are always generated by default, even if the | 2114 | ``-dbg`` packages are always generated by default, even if the |