diff options
Diffstat (limited to 'documentation/dev-manual/common-tasks.rst')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index fe3667bfb9..abeb1ed9c3 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -18,7 +18,7 @@ The OpenEmbedded build system supports organizing | |||
18 | Layers allow you to isolate different types of customizations from each | 18 | Layers allow you to isolate different types of customizations from each |
19 | other. For introductory information on the Yocto Project Layer Model, | 19 | other. For introductory information on the Yocto Project Layer Model, |
20 | see the | 20 | see the |
21 | ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" | 21 | ":ref:`overview-manual/yp-intro:the yocto project layer model`" |
22 | section in the Yocto Project Overview and Concepts Manual. | 22 | section in the Yocto Project Overview and Concepts Manual. |
23 | 23 | ||
24 | Creating Your Own Layer | 24 | Creating Your Own Layer |
@@ -1319,7 +1319,7 @@ to determine how well the build went. | |||
1319 | ``log.do_fetch``, and ``log.do_compile``). | 1319 | ``log.do_fetch``, and ``log.do_compile``). |
1320 | 1320 | ||
1321 | You can find more information about the build process in | 1321 | You can find more information about the build process in |
1322 | ":doc:`/overview-manual/overview-manual-development-environment`" | 1322 | ":doc:`/overview-manual/development-environment`" |
1323 | chapter of the Yocto Project Overview and Concepts Manual. | 1323 | chapter of the Yocto Project Overview and Concepts Manual. |
1324 | 1324 | ||
1325 | Fetching Code | 1325 | Fetching Code |
@@ -1330,7 +1330,7 @@ files. Fetching is controlled mainly through the | |||
1330 | :term:`SRC_URI` variable. Your recipe | 1330 | :term:`SRC_URI` variable. Your recipe |
1331 | must have a ``SRC_URI`` variable that points to where the source is | 1331 | must have a ``SRC_URI`` variable that points to where the source is |
1332 | located. For a graphical representation of source locations, see the | 1332 | located. For a graphical representation of source locations, see the |
1333 | ":ref:`overview-manual/overview-manual-concepts:sources`" section in | 1333 | ":ref:`overview-manual/concepts:sources`" section in |
1334 | the Yocto Project Overview and Concepts Manual. | 1334 | the Yocto Project Overview and Concepts Manual. |
1335 | 1335 | ||
1336 | The :ref:`ref-tasks-fetch` task uses | 1336 | The :ref:`ref-tasks-fetch` task uses |
@@ -1599,7 +1599,7 @@ package "example" contains "libexample" and another package "mypackage" | |||
1599 | contains a binary that links to "libexample" then the OpenEmbedded build | 1599 | contains a binary that links to "libexample" then the OpenEmbedded build |
1600 | system will automatically add a runtime dependency to "mypackage" on | 1600 | system will automatically add a runtime dependency to "mypackage" on |
1601 | "example"). See the | 1601 | "example"). See the |
1602 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 1602 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
1603 | section in the Yocto Project Overview and Concepts Manual for further | 1603 | section in the Yocto Project Overview and Concepts Manual for further |
1604 | details. | 1604 | details. |
1605 | 1605 | ||
@@ -2486,7 +2486,7 @@ Reference Manual's variable glossary. | |||
2486 | 2486 | ||
2487 | - Using ``DEPENDS`` also allows runtime dependencies between | 2487 | - Using ``DEPENDS`` also allows runtime dependencies between |
2488 | packages to be added automatically. See the | 2488 | packages to be added automatically. See the |
2489 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 2489 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
2490 | section in the Yocto Project Overview and Concepts Manual for more | 2490 | section in the Yocto Project Overview and Concepts Manual for more |
2491 | information. | 2491 | information. |
2492 | 2492 | ||
@@ -3658,7 +3658,7 @@ build host running Linux. | |||
3658 | The build process creates an entire Linux distribution from source and | 3658 | The build process creates an entire Linux distribution from source and |
3659 | places it in your :term:`Build Directory` under | 3659 | places it in your :term:`Build Directory` under |
3660 | ``tmp/deploy/images``. For detailed information on the build process | 3660 | ``tmp/deploy/images``. For detailed information on the build process |
3661 | using BitBake, see the ":ref:`overview-manual/overview-manual-concepts:images`" section in the | 3661 | using BitBake, see the ":ref:`overview-manual/concepts:images`" section in the |
3662 | Yocto Project Overview and Concepts Manual. | 3662 | Yocto Project Overview and Concepts Manual. |
3663 | 3663 | ||
3664 | The following figure and list overviews the build process: | 3664 | The following figure and list overviews the build process: |
@@ -5490,7 +5490,7 @@ Using an Existing Kickstart File | |||
5490 | 5490 | ||
5491 | If you do not want to create your own kickstart file, you can use an | 5491 | If you do not want to create your own kickstart file, you can use an |
5492 | existing file provided by the Wic installation. As shipped, kickstart | 5492 | existing file provided by the Wic installation. As shipped, kickstart |
5493 | files can be found in the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` in the | 5493 | files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the |
5494 | following two locations: | 5494 | following two locations: |
5495 | :: | 5495 | :: |
5496 | 5496 | ||
@@ -6526,7 +6526,7 @@ revision, respectively). The values are highly dependent on the policies | |||
6526 | and procedures of a given distribution and package feed. | 6526 | and procedures of a given distribution and package feed. |
6527 | 6527 | ||
6528 | Because the OpenEmbedded build system uses | 6528 | Because the OpenEmbedded build system uses |
6529 | ":ref:`signatures <overview-manual/overview-manual-concepts:checksums (signatures)>`", which are | 6529 | ":ref:`signatures <overview-manual/concepts:checksums (signatures)>`", which are |
6530 | unique to a given build, the build system knows when to rebuild | 6530 | unique to a given build, the build system knows when to rebuild |
6531 | packages. All the inputs into a given task are represented by a | 6531 | packages. All the inputs into a given task are represented by a |
6532 | signature, which can trigger a rebuild when different. Thus, the build | 6532 | signature, which can trigger a rebuild when different. Thus, the build |
@@ -6600,7 +6600,7 @@ Quality <#maintaining-build-output-quality>`__" section. | |||
6600 | use a PR Service while others do not leads to obvious problems. | 6600 | use a PR Service while others do not leads to obvious problems. |
6601 | 6601 | ||
6602 | For more information on shared state, see the | 6602 | For more information on shared state, see the |
6603 | ":ref:`overview-manual/overview-manual-concepts:shared state cache`" | 6603 | ":ref:`overview-manual/concepts:shared state cache`" |
6604 | section in the Yocto Project Overview and Concepts Manual. | 6604 | section in the Yocto Project Overview and Concepts Manual. |
6605 | 6605 | ||
6606 | Manually Bumping PR | 6606 | Manually Bumping PR |
@@ -6767,7 +6767,7 @@ multiple times if you have more than one set of modules to package. | |||
6767 | 6767 | ||
6768 | For more examples that show how to use ``do_split_packages``, see the | 6768 | For more examples that show how to use ``do_split_packages``, see the |
6769 | ``connman.inc`` file in the ``meta/recipes-connectivity/connman/`` | 6769 | ``connman.inc`` file in the ``meta/recipes-connectivity/connman/`` |
6770 | directory of the ``poky`` :ref:`source repository <overview-manual/overview-manual-development-environment:yocto project source repositories>`. You can | 6770 | directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can |
6771 | also find examples in ``meta/classes/kernel.bbclass``. | 6771 | also find examples in ``meta/classes/kernel.bbclass``. |
6772 | 6772 | ||
6773 | Following is a reference that shows ``do_split_packages`` mandatory and | 6773 | Following is a reference that shows ``do_split_packages`` mandatory and |
@@ -8080,7 +8080,7 @@ variable to "1" at the end of your ``conf/local.conf`` file found in the | |||
8080 | Enabling build history as | 8080 | Enabling build history as |
8081 | previously described causes the OpenEmbedded build system to collect | 8081 | previously described causes the OpenEmbedded build system to collect |
8082 | build output information and commit it as a single commit to a local | 8082 | build output information and commit it as a single commit to a local |
8083 | :ref:`overview-manual/overview-manual-development-environment:git` repository. | 8083 | :ref:`overview-manual/development-environment:git` repository. |
8084 | 8084 | ||
8085 | .. note:: | 8085 | .. note:: |
8086 | 8086 | ||
@@ -9394,7 +9394,7 @@ BitBake has determined by doing the following: | |||
9394 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 | 9394 | ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 |
9395 | 9395 | ||
9396 | For tasks that are accelerated through the shared state | 9396 | For tasks that are accelerated through the shared state |
9397 | (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, an | 9397 | (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, an |
9398 | additional ``siginfo`` file is written into | 9398 | additional ``siginfo`` file is written into |
9399 | :term:`SSTATE_DIR` along with | 9399 | :term:`SSTATE_DIR` along with |
9400 | the cached task output. The ``siginfo`` files contain exactly the | 9400 | the cached task output. The ``siginfo`` files contain exactly the |
@@ -9461,15 +9461,15 @@ files, see the "`Viewing Task Variable | |||
9461 | Dependencies <#dev-viewing-task-variable-dependencies>`__" section. | 9461 | Dependencies <#dev-viewing-task-variable-dependencies>`__" section. |
9462 | 9462 | ||
9463 | For conceptual information on shared state, see the | 9463 | For conceptual information on shared state, see the |
9464 | ":ref:`overview-manual/overview-manual-concepts:shared state`" | 9464 | ":ref:`overview-manual/concepts:shared state`" |
9465 | section in the Yocto Project Overview and Concepts Manual. | 9465 | section in the Yocto Project Overview and Concepts Manual. |
9466 | 9466 | ||
9467 | Invalidating Shared State to Force a Task to Run | 9467 | Invalidating Shared State to Force a Task to Run |
9468 | ------------------------------------------------ | 9468 | ------------------------------------------------ |
9469 | 9469 | ||
9470 | The OpenEmbedded build system uses | 9470 | The OpenEmbedded build system uses |
9471 | :ref:`checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` and | 9471 | :ref:`checksums <overview-manual/concepts:checksums (signatures)>` and |
9472 | :ref:`overview-manual/overview-manual-concepts:shared state` cache to avoid unnecessarily | 9472 | :ref:`overview-manual/concepts:shared state` cache to avoid unnecessarily |
9473 | rebuilding tasks. Collectively, this scheme is known as "shared state | 9473 | rebuilding tasks. Collectively, this scheme is known as "shared state |
9474 | code". | 9474 | code". |
9475 | 9475 | ||
@@ -9530,7 +9530,7 @@ tasks (including tasks from other recipes) that the specified task | |||
9530 | depends on will be run before the task. Even when you manually specify a | 9530 | depends on will be run before the task. Even when you manually specify a |
9531 | task to run with ``-c``, BitBake will only run the task if it considers | 9531 | task to run with ``-c``, BitBake will only run the task if it considers |
9532 | it "out of date". See the | 9532 | it "out of date". See the |
9533 | ":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`" | 9533 | ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" |
9534 | section in the Yocto Project Overview and Concepts Manual for how | 9534 | section in the Yocto Project Overview and Concepts Manual for how |
9535 | BitBake determines whether a task is "out of date". | 9535 | BitBake determines whether a task is "out of date". |
9536 | 9536 | ||
@@ -10458,7 +10458,7 @@ Yocto general mailing list or on the openembedded-devel mailing list. | |||
10458 | You can also push a change upstream and request a maintainer to pull the | 10458 | You can also push a change upstream and request a maintainer to pull the |
10459 | change into the component's upstream repository. You do this by pushing | 10459 | change into the component's upstream repository. You do this by pushing |
10460 | to a contribution repository that is upstream. See the | 10460 | to a contribution repository that is upstream. See the |
10461 | ":ref:`overview-manual/overview-manual-development-environment:git workflows and the yocto project`" | 10461 | ":ref:`overview-manual/development-environment:git workflows and the yocto project`" |
10462 | section in the Yocto Project Overview and Concepts Manual for additional | 10462 | section in the Yocto Project Overview and Concepts Manual for additional |
10463 | concepts on working in the Yocto Project development environment. | 10463 | concepts on working in the Yocto Project development environment. |
10464 | 10464 | ||
@@ -10707,7 +10707,7 @@ been followed: | |||
10707 | located in the :term:`Source Directory` at | 10707 | located in the :term:`Source Directory` at |
10708 | ``meta/conf/distro/include``, to see who is responsible for code. | 10708 | ``meta/conf/distro/include``, to see who is responsible for code. |
10709 | 10709 | ||
10710 | - *Search by File:* Using :ref:`overview-manual/overview-manual-development-environment:git`, you can | 10710 | - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can |
10711 | enter the following command to bring up a short list of all | 10711 | enter the following command to bring up a short list of all |
10712 | commits against a specific file: | 10712 | commits against a specific file: |
10713 | :: | 10713 | :: |
@@ -10856,7 +10856,7 @@ follows: | |||
10856 | Working With Licenses | 10856 | Working With Licenses |
10857 | ===================== | 10857 | ===================== |
10858 | 10858 | ||
10859 | As mentioned in the ":ref:`overview-manual/overview-manual-development-environment:licensing`" | 10859 | As mentioned in the ":ref:`overview-manual/development-environment:licensing`" |
10860 | section in the Yocto Project Overview and Concepts Manual, open source | 10860 | section in the Yocto Project Overview and Concepts Manual, open source |
10861 | projects are open to the public and they consequently have different | 10861 | projects are open to the public and they consequently have different |
10862 | licensing structures in place. This section describes the mechanism by | 10862 | licensing structures in place. This section describes the mechanism by |
@@ -11299,7 +11299,7 @@ By releasing the version of the OpenEmbedded build system and the layers | |||
11299 | used during the build, you will be providing both compilation scripts | 11299 | used during the build, you will be providing both compilation scripts |
11300 | and the source code modifications in one step. | 11300 | and the source code modifications in one step. |
11301 | 11301 | ||
11302 | If the deployment team has a :ref:`overview-manual/overview-manual-concepts:bsp layer` | 11302 | If the deployment team has a :ref:`overview-manual/concepts:bsp layer` |
11303 | and a distro layer, and those | 11303 | and a distro layer, and those |
11304 | those layers are used to patch, compile, package, or modify (in any way) | 11304 | those layers are used to patch, compile, package, or modify (in any way) |
11305 | any open source software included in your released images, you might be | 11305 | any open source software included in your released images, you might be |