summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst3
-rw-r--r--documentation/bsp-guide/bsp.rst4
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst32
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.rst2
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst22
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst8
-rw-r--r--documentation/ref-manual/migration.rst11
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst4
-rw-r--r--documentation/ref-manual/ref-structure.rst4
-rw-r--r--documentation/ref-manual/ref-tasks.rst6
-rw-r--r--documentation/ref-manual/ref-terms.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst34
-rw-r--r--documentation/ref-manual/resources.rst2
-rw-r--r--documentation/sdk-manual/sdk-extensible.rst2
14 files changed, 67 insertions, 71 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index 850f3136c1..5da7de2ac2 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -204,8 +204,7 @@ an entire Linux distribution, including the toolchain, from source.
204 command, see the 204 command, see the
205 "`BitBake <&YOCTO_DOCS_OM_URL;#usingpoky-components-bitbake>`__" 205 "`BitBake <&YOCTO_DOCS_OM_URL;#usingpoky-components-bitbake>`__"
206 section in the Yocto Project Overview and Concepts Manual, or see the 206 section in the Yocto Project Overview and Concepts Manual, or see the
207 "`BitBake 207 ":ref:`BitBake Command <bitbake:bitbake-user-manual-command>`" section
208 Command <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command>`__" section
209 in the BitBake User Manual. 208 in the BitBake User Manual.
210 209
2114. *Simulate Your Image Using QEMU:* Once this particular image is 2104. *Simulate Your Image Using QEMU:* Once this particular image is
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 663d9478a4..cdde41af63 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -789,8 +789,8 @@ workflow.
789 789
7907. *Build the Image:* The OpenEmbedded build system uses the BitBake 7907. *Build the Image:* The OpenEmbedded build system uses the BitBake
791 tool to build images based on the type of image you want to create. 791 tool to build images based on the type of image you want to create.
792 You can find more information about BitBake in the `BitBake User 792 You can find more information about BitBake in the
793 Manual <&YOCTO_DOCS_BB_URL;>`__. 793 :doc:`BitBake User Manual <bitbake:index>`.
794 794
795 The build process supports several types of images to satisfy 795 The build process supports several types of images to satisfy
796 different needs. See the 796 different needs. See the
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 953d853374..c9b8a834cf 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -1163,7 +1163,7 @@ the Yocto Project Overview and Concepts Manual.
1163 1163
1164The :ref:`ref-tasks-fetch` task uses 1164The :ref:`ref-tasks-fetch` task uses
1165the prefix of each entry in the ``SRC_URI`` variable value to determine 1165the prefix of each entry in the ``SRC_URI`` variable value to determine
1166which `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ to use to get your 1166which :ref:`fetcher <bitbake:bb-fetchers>` to use to get your
1167source files. It is the ``SRC_URI`` variable that triggers the fetcher. 1167source files. It is the ``SRC_URI`` variable that triggers the fetcher.
1168The :ref:`ref-tasks-patch` task uses 1168The :ref:`ref-tasks-patch` task uses
1169the variable after source is fetched to apply patches. The OpenEmbedded 1169the variable after source is fetched to apply patches. The OpenEmbedded
@@ -2302,10 +2302,10 @@ doing the following:
2302 If ``${S}`` might contain a Makefile, or if you inherit some class 2302 If ``${S}`` might contain a Makefile, or if you inherit some class
2303 that replaces ``do_configure`` and ``do_compile`` with custom 2303 that replaces ``do_configure`` and ``do_compile`` with custom
2304 versions, then you can use the 2304 versions, then you can use the
2305 ``[``\ ```noexec`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` 2305 ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
2306 flag to turn the tasks into no-ops, as follows: do_configure[noexec] 2306 flag to turn the tasks into no-ops, as follows: do_configure[noexec]
2307 = "1" do_compile[noexec] = "1" Unlike 2307 = "1" do_compile[noexec] = "1" Unlike
2308 ```deleting the tasks`` <&YOCTO_DOCS_BB_URL;#deleting-a-task>`__, 2308 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`,
2309 using the flag preserves the dependency chain from the 2309 using the flag preserves the dependency chain from the
2310 :ref:`ref-tasks-fetch`, 2310 :ref:`ref-tasks-fetch`,
2311 :ref:`ref-tasks-unpack`, and 2311 :ref:`ref-tasks-unpack`, and
@@ -2341,8 +2341,8 @@ Recipe Syntax
2341 2341
2342Understanding recipe file syntax is important for writing recipes. The 2342Understanding recipe file syntax is important for writing recipes. The
2343following list overviews the basic items that make up a BitBake recipe 2343following list overviews the basic items that make up a BitBake recipe
2344file. For more complete BitBake syntax descriptions, see the "`Syntax 2344file. For more complete BitBake syntax descriptions, see the
2345and Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__" 2345":doc:`bitbake-user-manual/bitbake-user-manual-metadata`"
2346chapter of the BitBake User Manual. 2346chapter of the BitBake User Manual.
2347 2347
2348- *Variable Assignments and Manipulations:* Variable assignments allow 2348- *Variable Assignments and Manipulations:* Variable assignments allow
@@ -2385,8 +2385,8 @@ chapter of the BitBake User Manual.
2385 2385
2386This next list summarizes the most important and most commonly used 2386This next list summarizes the most important and most commonly used
2387parts of the recipe syntax. For more information on these parts of the 2387parts of the recipe syntax. For more information on these parts of the
2388syntax, you can reference the `Syntax and 2388syntax, you can reference the
2389Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__ chapter 2389:doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata` chapter
2390in the BitBake User Manual. 2390in the BitBake User Manual.
2391 2391
2392- *Line Continuation (\):* Use the backward slash (``\``) character to 2392- *Line Continuation (\):* Use the backward slash (``\``) character to
@@ -6661,7 +6661,7 @@ Creating Node Package Manager (NPM) Packages
6661 6661
6662`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package 6662`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package
6663manager for the JavaScript programming language. The Yocto Project 6663manager for the JavaScript programming language. The Yocto Project
6664supports the NPM `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__. You can 6664supports the NPM :ref:`fetcher <bitbake:bb-fetchers>`. You can
6665use this fetcher in combination with 6665use this fetcher in combination with
6666```devtool`` <&YOCTO_DOCS_REF_URL;#ref-devtool-reference>`__ to create 6666```devtool`` <&YOCTO_DOCS_REF_URL;#ref-devtool-reference>`__ to create
6667recipes that produce NPM packages. 6667recipes that produce NPM packages.
@@ -8239,9 +8239,9 @@ Viewing Variable Values
8239 8239
8240Sometimes you need to know the value of a variable as a result of 8240Sometimes you need to know the value of a variable as a result of
8241BitBake's parsing step. This could be because some unexpected behavior 8241BitBake's parsing step. This could be because some unexpected behavior
8242occurred in your project. Perhaps an attempt to `modify a 8242occurred in your project. Perhaps an attempt to :ref:`modify a variable
8243variable <&YOCTO_DOCS_BB_URL;#modifying-existing-variables>`__ did not 8243<bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing
8244work out as expected. 8244variables>` did not work out as expected.
8245 8245
8246BitBake's ``-e`` option is used to display variable values after 8246BitBake's ``-e`` option is used to display variable values after
8247parsing. The following command displays the variable values after the 8247parsing. The following command displays the variable values after the
@@ -8404,15 +8404,15 @@ dependencies for the recipes involved in building recipename.
8404Viewing Task Variable Dependencies 8404Viewing Task Variable Dependencies
8405---------------------------------- 8405----------------------------------
8406 8406
8407As mentioned in the "`Checksums 8407As mentioned in the
8408(Signatures) <&YOCTO_DOCS_BB_URL;#checksums>`__" section of the BitBake 8408":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake
8409User Manual, BitBake tries to automatically determine what variables a 8409User Manual, BitBake tries to automatically determine what variables a
8410task depends on so that it can rerun the task if any values of the 8410task depends on so that it can rerun the task if any values of the
8411variables change. This determination is usually reliable. However, if 8411variables change. This determination is usually reliable. However, if
8412you do things like construct variable names at runtime, then you might 8412you do things like construct variable names at runtime, then you might
8413have to manually declare dependencies on those variables using 8413have to manually declare dependencies on those variables using
8414``vardeps`` as described in the "`Variable 8414``vardeps`` as described in the
8415Flags <&YOCTO_DOCS_BB_URL;#variable-flags>`__" section of the BitBake 8415":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake
8416User Manual. 8416User Manual.
8417 8417
8418If you are unsure whether a variable dependency is being picked up 8418If you are unsure whether a variable dependency is being picked up
@@ -8691,7 +8691,7 @@ log to ``${T}/log.do_``\ task, and can also log to standard output
8691 8691
8692- ``bb.debug(``\ level\ ``, ``\ msg\ ``)``: Writes "DEBUG: msg" to the 8692- ``bb.debug(``\ level\ ``, ``\ msg\ ``)``: Writes "DEBUG: msg" to the
8693 log. Also logs to stdout if the log level is greater than or equal to 8693 log. Also logs to stdout if the log level is greater than or equal to
8694 level. See the "`-D <&YOCTO_DOCS_BB_URL;#usage-and-syntax>`__" option 8694 level. See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
8695 in the BitBake User Manual for more information. 8695 in the BitBake User Manual for more information.
8696 8696
8697- ``bb.warn(``\ msg\ ``)``: Writes "WARNING: msg" to the log while also 8697- ``bb.warn(``\ msg\ ``)``: Writes "WARNING: msg" to the log while also
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst
index cef5966ca9..6d7f4c91d3 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/kernel-dev-advanced.rst
@@ -316,7 +316,7 @@ in the "`Features <#features>`__" section. The
316variable in the kernel recipe selects the kernel type. For example, in 316variable in the kernel recipe selects the kernel type. For example, in
317the ``linux-yocto_4.12.bb`` kernel recipe found in 317the ``linux-yocto_4.12.bb`` kernel recipe found in
318``poky/meta/recipes-kernel/linux``, a 318``poky/meta/recipes-kernel/linux``, a
319```require`` <&YOCTO_DOCS_BB_URL;#require-inclusion>`__ directive 319:ref:`require <bitbake:require-inclusion>` directive
320includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, 320includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file,
321which has the following statement that defines the default kernel type: 321which has the following statement that defines the default kernel type:
322LINUX_KERNEL_TYPE ??= "standard" 322LINUX_KERNEL_TYPE ??= "standard"
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.
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
779BitBake also supports both ``_prepend`` and ``_append`` operators as a 779BitBake also supports both ``_prepend`` and ``_append`` operators as a
780method of extending task functionality. These operators inject code into 780method of extending task functionality. These operators inject code into
781the beginning or end of a task. For information on these BitBake 781the beginning or end of a task. For information on these BitBake
782operators, see the "`Appending and Prepending (Override Style 782operators, see the
783Syntax) <&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)`"
784section in the BitBake User's Manual. 784section in the BitBake User's Manual.
785 785
786.. _openembedded-build-system-workflow: 786.. _openembedded-build-system-workflow:
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 9e821c5dd3..f834ba7004 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -2452,7 +2452,7 @@ compared to uClibc.
2452``${``\ :term:`B`\ ``}`` is no longer the default working 2452``${``\ :term:`B`\ ``}`` is no longer the default working
2453directory for tasks. Consequently, any custom tasks you define now need 2453directory for tasks. Consequently, any custom tasks you define now need
2454to either have the 2454to either have the
2455``[``\ ```dirs`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` flag 2455``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag
2456set, or the task needs to change into the appropriate working directory 2456set, or the task needs to change into the appropriate working directory
2457manually (e.g using ``cd`` for a shell task). 2457manually (e.g using ``cd`` for a shell task).
2458 2458
@@ -2942,8 +2942,8 @@ The following changes took place for BitBake:
2942 fetcher passes the new parameter through the ``SVN_SSH`` environment 2942 fetcher passes the new parameter through the ``SVN_SSH`` environment
2943 variable during the :ref:`ref-tasks-fetch` task. 2943 variable during the :ref:`ref-tasks-fetch` task.
2944 2944
2945 See the "`Subversion (SVN) Fetcher 2945 See the ":ref:`bitbake:svn-fetcher`"
2946 (svn://) <&YOCTO_DOCS_BB_URL;#svn-fetcher>`__" section in the BitBake 2946 section in the BitBake
2947 User Manual for additional information. 2947 User Manual for additional information.
2948 2948
2949- *``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` 2949- *``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
@@ -3546,7 +3546,7 @@ The following are additional changes:
3546 3546
3547- BitBake fires multiple "BuildStarted" events when multiconfig is 3547- BitBake fires multiple "BuildStarted" events when multiconfig is
3548 enabled (one per configuration). For more information, see the 3548 enabled (one per configuration). For more information, see the
3549 "`Events <&YOCTO_DOCS_BB_URL;#events>`__" section in the BitBake User 3549 ":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User
3550 Manual. 3550 Manual.
3551 3551
3552- By default, the ``security_flags.inc`` file sets a 3552- By default, the ``security_flags.inc`` file sets a
@@ -4143,8 +4143,7 @@ The following changes have occurred:
4143 specifying list items to remove, be aware that leading and trailing 4143 specifying list items to remove, be aware that leading and trailing
4144 whitespace resulting from the removal is retained. 4144 whitespace resulting from the removal is retained.
4145 4145
4146 See the "`Removal (Override Style 4146 See the ":ref:`bitbake:removing-override-style-syntax`"
4147 Syntax) <&YOCTO_DOCS_BB_URL;#removing-override-style-syntax>`__"
4148 section in the BitBake User Manual for a detailed example. 4147 section in the BitBake User Manual for a detailed example.
4149 4148
4150.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: 4149.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 418c9623f6..ca1d7fd0cb 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -290,8 +290,8 @@ particular recipe.
290 ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc 290 ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc
291 file. 291 file.
292 292
293 - If the recipe is using the `Git 293 - If the recipe is using the :ref:`bitbake:git-fetcher`
294 fetcher <&YOCTO_DOCS_BB_URL;#git-fetcher>`__ rather than a 294 rather than a
295 tarball, the commit hash points to the commit that matches the 295 tarball, the commit hash points to the commit that matches the
296 recipe's latest version tag. 296 recipe's latest version tag.
297 297
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index a21c0bdd52..03648148c2 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -46,8 +46,8 @@ environment setup script (i.e. ````` <#structure-core-script>`__) places
46the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into 46the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into
47the shell's ``PATH`` environment variable. 47the shell's ``PATH`` environment variable.
48 48
49For more information on BitBake, see the `BitBake User 49For more information on BitBake, see the :doc:`BitBake User Manual
50Manual <&YOCTO_DOCS_BB_URL;>`__. 50<bitbake:index>`.
51 51
52.. _structure-core-build: 52.. _structure-core-build:
53 53
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index f56f7a993f..5b0711586f 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -14,8 +14,8 @@ Normal Recipe Build Tasks
14 14
15The following sections describe normal tasks associated with building a 15The following sections describe normal tasks associated with building a
16recipe. For more information on tasks and dependencies, see the 16recipe. For more information on tasks and dependencies, see the
17"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 17":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
18"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 18":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
19BitBake User Manual. 19BitBake User Manual.
20 20
21.. _ref-tasks-build: 21.. _ref-tasks-build:
@@ -125,7 +125,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed
125 125
126Fetches the source code. This task uses the 126Fetches the source code. This task uses the
127:term:`SRC_URI` variable and the argument's prefix to 127:term:`SRC_URI` variable and the argument's prefix to
128determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ 128determine the correct :ref:`fetcher <bitbake:bb-fetchers>`
129module. 129module.
130 130
131.. _ref-tasks-image: 131.. _ref-tasks-image:
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index ec9f6d3948..24eff62bcd 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -47,8 +47,8 @@ universal, the list includes them just in case:
47 47
48 BitBake 48 BitBake
49 The task executor and scheduler used by the OpenEmbedded build system to 49 The task executor and scheduler used by the OpenEmbedded build system to
50 build images. For more information on BitBake, see the `BitBake User 50 build images. For more information on BitBake, see the :doc:`BitBake User
51 Manual <&YOCTO_DOCS_BB_URL;>`__. 51 Manual <bitbake:index>`.
52 52
53 Board Support Package (BSP) 53 Board Support Package (BSP)
54 A group of drivers, definitions, and other components that provide support 54 A group of drivers, definitions, and other components that provide support
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 6f70787cbb..485fbb27f5 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -239,8 +239,8 @@ system and gives an overview of their function and contents.
239 239
240 To add a tune to the list, be sure to append it with spaces using the 240 To add a tune to the list, be sure to append it with spaces using the
241 "+=" BitBake operator. Do not simply replace the list by using the 241 "+=" BitBake operator. Do not simply replace the list by using the
242 "=" operator. See the "`Basic 242 "=" operator. See the
243 Syntax <&YOCTO_DOCS_BB_URL;#basic-syntax>`__" section in the BitBake 243 ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake
244 User Manual for more information. 244 User Manual for more information.
245 245
246 B 246 B
@@ -1477,7 +1477,7 @@ system and gives an overview of their function and contents.
1477 This mechanism is implemented by having ``do_configure`` depend on 1477 This mechanism is implemented by having ``do_configure`` depend on
1478 the :ref:`ref-tasks-populate_sysroot` task of 1478 the :ref:`ref-tasks-populate_sysroot` task of
1479 each recipe listed in ``DEPENDS``, through a 1479 each recipe listed in ``DEPENDS``, through a
1480 ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` 1480 ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
1481 declaration in the :ref:`base <ref-classes-base>` class. 1481 declaration in the :ref:`base <ref-classes-base>` class.
1482 1482
1483 .. note:: 1483 .. note::
@@ -1524,8 +1524,8 @@ system and gives an overview of their function and contents.
1524 1524
1525 For information on runtime dependencies, see the 1525 For information on runtime dependencies, see the
1526 :term:`RDEPENDS` variable. You can also see the 1526 :term:`RDEPENDS` variable. You can also see the
1527 "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 1527 ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
1528 "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 1528 ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
1529 BitBake User Manual for additional information on tasks and 1529 BitBake User Manual for additional information on tasks and
1530 dependencies. 1530 dependencies.
1531 1531
@@ -2270,8 +2270,8 @@ system and gives an overview of their function and contents.
2270 :term:`FILESPATH` variable. For an example of how 2270 :term:`FILESPATH` variable. For an example of how
2271 that works, see the :term:`FILESPATH` variable 2271 that works, see the :term:`FILESPATH` variable
2272 description. Additionally, you find more information on how overrides 2272 description. Additionally, you find more information on how overrides
2273 are handled in the "`Conditional Syntax 2273 are handled in the
2274 (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__" 2274 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
2275 section of the BitBake User Manual. 2275 section of the BitBake User Manual.
2276 2276
2277 By default, the ``FILESOVERRIDES`` variable is defined as: 2277 By default, the ``FILESOVERRIDES`` variable is defined as:
@@ -2789,13 +2789,13 @@ system and gives an overview of their function and contents.
2789 section in the Yocto Project Development Tasks Manual. 2789 section in the Yocto Project Development Tasks Manual.
2790 2790
2791 - Using ``IMAGE_INSTALL`` with the 2791 - Using ``IMAGE_INSTALL`` with the
2792 ```+=`` <&YOCTO_DOCS_BB_URL;#appending-and-prepending>`__ 2792 :ref:`+= <bitbake:appending-and-prepending>`
2793 BitBake operator within the ``/conf/local.conf`` file or from 2793 BitBake operator within the ``/conf/local.conf`` file or from
2794 within an image recipe is not recommended. Use of this operator 2794 within an image recipe is not recommended. Use of this operator
2795 in these ways can cause ordering issues. Since 2795 in these ways can cause ordering issues. Since
2796 ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default 2796 ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default
2797 value using the 2797 value using the
2798 ```?=`` <&YOCTO_DOCS_BB_URL;#setting-a-default-value>`__ 2798 :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
2799 operator, using a ``+=`` operation against ``IMAGE_INSTALL`` 2799 operator, using a ``+=`` operation against ``IMAGE_INSTALL``
2800 results in unexpected behavior when used within 2800 results in unexpected behavior when used within
2801 ``conf/local.conf``. Furthermore, the same operation from 2801 ``conf/local.conf``. Furthermore, the same operation from
@@ -3078,9 +3078,8 @@ system and gives an overview of their function and contents.
3078 configuration and in each individual recipe. The OpenEmbedded build 3078 configuration and in each individual recipe. The OpenEmbedded build
3079 system ignores changes to ``INHERIT`` in individual recipes. 3079 system ignores changes to ``INHERIT`` in individual recipes.
3080 3080
3081 For more information on ``INHERIT``, see the "```INHERIT`` 3081 For more information on ``INHERIT``, see the
3082 Configuration 3082 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
3083 Directive <&YOCTO_DOCS_BB_URL;#inherit-configuration-directive>`__"
3084 section in the Bitbake User Manual. 3083 section in the Bitbake User Manual.
3085 3084
3086 INHERIT_DISTRO 3085 INHERIT_DISTRO
@@ -4415,9 +4414,8 @@ system and gives an overview of their function and contents.
4415 As an example, if the string "an-override" appears as an element in 4414 As an example, if the string "an-override" appears as an element in
4416 the colon-separated list in ``OVERRIDES``, then the following 4415 the colon-separated list in ``OVERRIDES``, then the following
4417 assignment will override ``FOO`` with the value "overridden" at the 4416 assignment will override ``FOO`` with the value "overridden" at the
4418 end of parsing: FOO_an-override = "overridden" See the "`Conditional 4417 end of parsing: FOO_an-override = "overridden" See the
4419 Syntax 4418 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
4420 (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__"
4421 section in the BitBake User Manual for more information on the 4419 section in the BitBake User Manual for more information on the
4422 overrides mechanism. 4420 overrides mechanism.
4423 4421
@@ -5502,8 +5500,8 @@ system and gives an overview of their function and contents.
5502 5500
5503 For information on build-time dependencies, see the 5501 For information on build-time dependencies, see the
5504 :term:`DEPENDS` variable. You can also see the 5502 :term:`DEPENDS` variable. You can also see the
5505 "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 5503 ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
5506 "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 5504 ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
5507 BitBake User Manual for additional information on tasks and 5505 BitBake User Manual for additional information on tasks and
5508 dependencies. 5506 dependencies.
5509 5507
@@ -6254,7 +6252,7 @@ system and gives an overview of their function and contents.
6254 protocols are highly dependent on particular BitBake Fetcher 6252 protocols are highly dependent on particular BitBake Fetcher
6255 submodules. Depending on the fetcher BitBake uses, various URL 6253 submodules. Depending on the fetcher BitBake uses, various URL
6256 parameters are employed. For specifics on the supported Fetchers, see 6254 parameters are employed. For specifics on the supported Fetchers, see
6257 the "`Fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__" section in the 6255 the ":ref:`Fetchers <bitbake:bb-fetchers>`" section in the
6258 BitBake User Manual. 6256 BitBake User Manual.
6259 6257
6260 - *``file://`` -* Fetches files, which are usually files shipped 6258 - *``file://`` -* Fetches files, which are usually files shipped
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index b443cbfb79..c5ddcca97f 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -123,7 +123,7 @@ Here is a list of resources you might find helpful:
123- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool 123- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool
124 used to process metadata. 124 used to process metadata.
125 125
126- `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__\ *:* A comprehensive 126- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
127 guide to the BitBake tool. If you want information on BitBake, see 127 guide to the BitBake tool. If you want information on BitBake, see
128 this manual. 128 this manual.
129 129
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst
index 2652b4acd4..5836bd8549 100644
--- a/documentation/sdk-manual/sdk-extensible.rst
+++ b/documentation/sdk-manual/sdk-extensible.rst
@@ -577,7 +577,7 @@ specify source code revision and versioning schemes, extract code into
577or out of the ``devtool`` 577or out of the ``devtool``
578:ref:`devtool-the-workspace-layer-structure`, 578:ref:`devtool-the-workspace-layer-structure`,
579and work with any source file forms that the 579and work with any source file forms that the
580`fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ support. 580:ref:`fetchers <bitbake:bb-fetchers>` support.
581 581
582The following diagram shows the common development flow used with the 582The following diagram shows the common development flow used with the
583``devtool upgrade`` command: 583``devtool upgrade`` command: