summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-concepts.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-31 17:58:42 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commitf3e7db78adf417231ce29eb6a9a28a74857a2954 (patch)
treec6faab74fc9b7b2d368bd610486065f3ab53e580 /documentation/overview-manual/overview-manual-concepts.rst
parent18df4a836845c6d7dec389a95623a472c19acdfe (diff)
downloadpoky-f3e7db78adf417231ce29eb6a9a28a74857a2954.tar.gz
sphinx: add links to section in the Bitbake manual
Use intersphinx extension to replace links to the Bitbake manual with proper cross references. (From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c) 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.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 0986de6ea1..7f8f735b37 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -54,7 +54,7 @@ for parsing the :term:`Metadata`, generating
54a list of tasks from it, and then executing those tasks. 54a list of tasks from it, and then executing those tasks.
55 55
56This section briefly introduces BitBake. If you want more information on 56This section briefly introduces BitBake. If you want more information on
57BitBake, see the `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__. 57BitBake, see the :doc:`BitBake User Manual <bitbake:index>`.
58 58
59To see a list of the options BitBake supports, use either of the 59To see a list of the options BitBake supports, use either of the
60following commands: $ bitbake -h $ bitbake --help 60following commands: $ bitbake -h $ bitbake --help
@@ -69,7 +69,7 @@ versions of ``matchbox-desktop`` might exist. BitBake chooses the one
69selected by the distribution configuration. You can get more details 69selected by the distribution configuration. You can get more details
70about how BitBake chooses between different target versions and 70about how BitBake chooses between different target versions and
71providers in the 71providers in the
72"`Preferences <&YOCTO_DOCS_BB_URL;#bb-bitbake-preferences>`__" section 72":ref:`Preferences <bitbake:bb-bitbake-preferences>`" section
73of the BitBake User Manual. 73of the BitBake User Manual.
74 74
75BitBake also tries to execute any dependent tasks first. So for example, 75BitBake also tries to execute any dependent tasks first. So for example,
@@ -361,8 +361,8 @@ environment. It is important to understand that the
361:term:`OpenEmbedded Build System` reads the 361:term:`OpenEmbedded Build System` reads the
362configuration files in a specific order: ``site.conf``, ``auto.conf``, 362configuration files in a specific order: ``site.conf``, ``auto.conf``,
363and ``local.conf``. And, the build system applies the normal assignment 363and ``local.conf``. And, the build system applies the normal assignment
364statement rules as described in the "`Syntax and 364statement rules as described in the
365Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__" chapter 365":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter
366of the BitBake User Manual. Because the files are parsed in a specific 366of the BitBake User Manual. Because the files are parsed in a specific
367order, variable assignments for the same variable could be affected. For 367order, variable assignments for the same variable could be affected. For
368example, if the ``auto.conf`` file and the ``local.conf`` set variable1 368example, if the ``auto.conf`` file and the ``local.conf`` set variable1
@@ -599,7 +599,7 @@ Source Control Managers (Optional)
599~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 599~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
600 600
601Another place from which the build system can get source files is with 601Another place from which the build system can get source files is with
602`fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ employing various Source 602:ref:`fetchers <bitbake:bb-fetchers>` employing various Source
603Control Managers (SCMs) such as Git or Subversion. In such cases, a 603Control Managers (SCMs) such as Git or Subversion. In such cases, a
604repository is cloned or checked out. The 604repository is cloned or checked out. The
605:ref:`ref-tasks-fetch` task inside 605:ref:`ref-tasks-fetch` task inside
@@ -1212,7 +1212,7 @@ Since ``STAMPS_DIR`` is usually a subdirectory of ``TMPDIR``, removing
1212properly be rerun to repopulate ``TMPDIR``. 1212properly be rerun to repopulate ``TMPDIR``.
1213 1213
1214If you want some task to always be considered "out of date", you can 1214If you want some task to always be considered "out of date", you can
1215mark it with the ```nostamp`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__ 1215mark it with the :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`
1216varflag. If some other task depends on such a task, then that task will 1216varflag. If some other task depends on such a task, then that task will
1217also always be considered out of date, which might not be what you want. 1217also always be considered out of date, which might not be what you want.
1218 1218
@@ -1913,14 +1913,14 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
1913 through the shared state cache if possible. If the task was 1913 through the shared state cache if possible. If the task was
1914 accelerated, ``sstate_setscene()`` returns True. Otherwise, it 1914 accelerated, ``sstate_setscene()`` returns True. Otherwise, it
1915 returns False, and the normal ``do_deploy`` task runs. For more 1915 returns False, and the normal ``do_deploy`` task runs. For more
1916 information, see the "`setscene <&YOCTO_DOCS_BB_URL;#setscene>`__" 1916 information, see the ":ref:`setscene <bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene>`"
1917 section in the BitBake User Manual. 1917 section in the BitBake User Manual.
1918 1918
1919- The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates 1919- The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates
1920 ``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and 1920 ``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and
1921 also sets the current working directory of ``do_deploy`` to ``${B}``. 1921 also sets the current working directory of ``do_deploy`` to ``${B}``.
1922 For more information, see the "`Variable 1922 For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`"
1923 Flags <&YOCTO_DOCS_BB_URL;#variable-flags>`__" section in the BitBake 1923 section in the BitBake
1924 User Manual. 1924 User Manual.
1925 1925
1926 .. note:: 1926 .. note::
@@ -1947,7 +1947,7 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
1947 extra metadata to the `stamp 1947 extra metadata to the `stamp
1948 file <#stamp-files-and-the-rerunning-of-tasks>`__. In this case, the 1948 file <#stamp-files-and-the-rerunning-of-tasks>`__. In this case, the
1949 metadata makes the task specific to a machine's architecture. See 1949 metadata makes the task specific to a machine's architecture. See
1950 "`The Task List <&YOCTO_DOCS_BB_URL;#ref-bitbake-tasklist>`__" 1950 ":ref:`bitbake:ref-bitbake-tasklist`"
1951 section in the BitBake User Manual for more information on the 1951 section in the BitBake User Manual for more information on the
1952 ``stamp-extra-info`` flag. 1952 ``stamp-extra-info`` flag.
1953 1953
@@ -2106,7 +2106,7 @@ dependencies, you must manually declare the dependencies.
2106 2106
2107The ``do_package`` task depends on the ``do_packagedata`` task of each 2107The ``do_package`` task depends on the ``do_packagedata`` task of each
2108recipe in :term:`DEPENDS` through use 2108recipe in :term:`DEPENDS` through use
2109of a ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` 2109of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
2110declaration, which guarantees that the required 2110declaration, which guarantees that the required
2111shared-library/module-to-package mapping information will be available 2111shared-library/module-to-package mapping information will be available
2112when needed as long as ``DEPENDS`` has been correctly set. 2112when needed as long as ``DEPENDS`` has been correctly set.