diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-31 17:58:42 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | f3e7db78adf417231ce29eb6a9a28a74857a2954 (patch) | |
tree | c6faab74fc9b7b2d368bd610486065f3ab53e580 /documentation/overview-manual | |
parent | 18df4a836845c6d7dec389a95623a472c19acdfe (diff) | |
download | poky-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')
-rw-r--r-- | documentation/overview-manual/overview-manual-concepts.rst | 22 | ||||
-rw-r--r-- | documentation/overview-manual/overview-manual-yp-intro.rst | 8 |
2 files changed, 15 insertions, 15 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 | |||
54 | a list of tasks from it, and then executing those tasks. | 54 | a list of tasks from it, and then executing those tasks. |
55 | 55 | ||
56 | This section briefly introduces BitBake. If you want more information on | 56 | This section briefly introduces BitBake. If you want more information on |
57 | BitBake, see the `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__. | 57 | BitBake, see the :doc:`BitBake User Manual <bitbake:index>`. |
58 | 58 | ||
59 | To see a list of the options BitBake supports, use either of the | 59 | To see a list of the options BitBake supports, use either of the |
60 | following commands: $ bitbake -h $ bitbake --help | 60 | following commands: $ bitbake -h $ bitbake --help |
@@ -69,7 +69,7 @@ versions of ``matchbox-desktop`` might exist. BitBake chooses the one | |||
69 | selected by the distribution configuration. You can get more details | 69 | selected by the distribution configuration. You can get more details |
70 | about how BitBake chooses between different target versions and | 70 | about how BitBake chooses between different target versions and |
71 | providers in the | 71 | providers in the |
72 | "`Preferences <&YOCTO_DOCS_BB_URL;#bb-bitbake-preferences>`__" section | 72 | ":ref:`Preferences <bitbake:bb-bitbake-preferences>`" section |
73 | of the BitBake User Manual. | 73 | of the BitBake User Manual. |
74 | 74 | ||
75 | BitBake also tries to execute any dependent tasks first. So for example, | 75 | BitBake 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 |
362 | configuration files in a specific order: ``site.conf``, ``auto.conf``, | 362 | configuration files in a specific order: ``site.conf``, ``auto.conf``, |
363 | and ``local.conf``. And, the build system applies the normal assignment | 363 | and ``local.conf``. And, the build system applies the normal assignment |
364 | statement rules as described in the "`Syntax and | 364 | statement rules as described in the |
365 | Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__" chapter | 365 | ":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter |
366 | of the BitBake User Manual. Because the files are parsed in a specific | 366 | of the BitBake User Manual. Because the files are parsed in a specific |
367 | order, variable assignments for the same variable could be affected. For | 367 | order, variable assignments for the same variable could be affected. For |
368 | example, if the ``auto.conf`` file and the ``local.conf`` set variable1 | 368 | example, if the ``auto.conf`` file and the ``local.conf`` set variable1 |
@@ -599,7 +599,7 @@ Source Control Managers (Optional) | |||
599 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 599 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
600 | 600 | ||
601 | Another place from which the build system can get source files is with | 601 | Another 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 |
603 | Control Managers (SCMs) such as Git or Subversion. In such cases, a | 603 | Control Managers (SCMs) such as Git or Subversion. In such cases, a |
604 | repository is cloned or checked out. The | 604 | repository 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 | |||
1212 | properly be rerun to repopulate ``TMPDIR``. | 1212 | properly be rerun to repopulate ``TMPDIR``. |
1213 | 1213 | ||
1214 | If you want some task to always be considered "out of date", you can | 1214 | If you want some task to always be considered "out of date", you can |
1215 | mark it with the ```nostamp`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__ | 1215 | mark it with the :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>` |
1216 | varflag. If some other task depends on such a task, then that task will | 1216 | varflag. If some other task depends on such a task, then that task will |
1217 | also always be considered out of date, which might not be what you want. | 1217 | also 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 | ||
2107 | The ``do_package`` task depends on the ``do_packagedata`` task of each | 2107 | The ``do_package`` task depends on the ``do_packagedata`` task of each |
2108 | recipe in :term:`DEPENDS` through use | 2108 | recipe in :term:`DEPENDS` through use |
2109 | of a ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` | 2109 | of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` |
2110 | declaration, which guarantees that the required | 2110 | declaration, which guarantees that the required |
2111 | shared-library/module-to-package mapping information will be available | 2111 | shared-library/module-to-package mapping information will be available |
2112 | when needed as long as ``DEPENDS`` has been correctly set. | 2112 | when needed as long as ``DEPENDS`` has been correctly set. |
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index 743353547e..1a71308fc0 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst | |||
@@ -474,8 +474,8 @@ The following list consists of components associated with the | |||
474 | is a build engine that works through recipes written in a specific | 474 | is a build engine that works through recipes written in a specific |
475 | format in order to perform sets of tasks. | 475 | format in order to perform sets of tasks. |
476 | 476 | ||
477 | You can learn more about BitBake in the `BitBake User | 477 | You can learn more about BitBake in the :doc:`BitBake User |
478 | Manual <&YOCTO_DOCS_BB_URL;>`__. | 478 | Manual <bitbake:index>`. |
479 | 479 | ||
480 | - *OpenEmbedded-Core:* OpenEmbedded-Core (OE-Core) is a common layer of | 480 | - *OpenEmbedded-Core:* OpenEmbedded-Core (OE-Core) is a common layer of |
481 | metadata (i.e. recipes, classes, and associated files) used by | 481 | metadata (i.e. recipes, classes, and associated files) used by |
@@ -779,8 +779,8 @@ additional tasks as well as task prerequisites. Recipe syntax through | |||
779 | BitBake also supports both ``_prepend`` and ``_append`` operators as a | 779 | BitBake also supports both ``_prepend`` and ``_append`` operators as a |
780 | method of extending task functionality. These operators inject code into | 780 | method of extending task functionality. These operators inject code into |
781 | the beginning or end of a task. For information on these BitBake | 781 | the beginning or end of a task. For information on these BitBake |
782 | operators, see the "`Appending and Prepending (Override Style | 782 | operators, see the |
783 | Syntax) <&YOCTO_DOCS_BB_URL;#appending-and-prepending-override-style-syntax>`__" | 783 | ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`" |
784 | section in the BitBake User's Manual. | 784 | section in the BitBake User's Manual. |
785 | 785 | ||
786 | .. _openembedded-build-system-workflow: | 786 | .. _openembedded-build-system-workflow: |