summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.rst')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst39
1 files changed, 18 insertions, 21 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 4257a4bb99..891fd9b001 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -75,7 +75,7 @@ Follow these general steps to create your layer without using tools:
75 ``conf`` directory and then modify the file as needed. 75 ``conf`` directory and then modify the file as needed.
76 76
77 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project 77 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project
78 :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>` 78 :yocto_git:`Source Repositories </poky/tree/meta-yocto-bsp/conf>`
79 demonstrates the required syntax. For your layer, you need to replace 79 demonstrates the required syntax. For your layer, you need to replace
80 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" 80 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz"
81 for a layer named "meta-machinexyz"): 81 for a layer named "meta-machinexyz"):
@@ -2107,15 +2107,12 @@ being able to provide the ``virtual/kernel`` item.
2107 2107
2108Now comes the time to actually build an image and you need a kernel 2108Now comes the time to actually build an image and you need a kernel
2109recipe, but which one? You can configure your build to call out the 2109recipe, but which one? You can configure your build to call out the
2110kernel recipe you want by using the 2110kernel recipe you want by using the :term:`PREFERRED_PROVIDER` variable. As
2111:term:`PREFERRED_PROVIDER` 2111an example, consider the :yocto_git:`x86-base.inc
2112variable. As an example, consider the 2112</poky/tree/meta/conf/machine/include/x86-base.inc>` include file, which is a
2113`x86-base.inc <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`_ 2113machine (i.e. :term:`MACHINE`) configuration file. This include file is the
2114include file, which is a machine (i.e. 2114reason all x86-based machines use the ``linux-yocto`` kernel. Here are the
2115:term:`MACHINE`) configuration file. 2115relevant lines from the include file:
2116This include file is the reason all x86-based machines use the
2117``linux-yocto`` kernel. Here are the relevant lines from the include
2118file:
2119:: 2116::
2120 2117
2121 PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto" 2118 PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto"
@@ -3058,7 +3055,7 @@ The following steps describe how to set up the AUH utility:
30587. *Create and Edit an AUH Configuration File:* You need to have the 30557. *Create and Edit an AUH Configuration File:* You need to have the
3059 ``upgrade-helper/upgrade-helper.conf`` configuration file in your 3056 ``upgrade-helper/upgrade-helper.conf`` configuration file in your
3060 build directory. You can find a sample configuration file in the 3057 build directory. You can find a sample configuration file in the
3061 :yocto_git:`AUH source repository </cgit/cgit.cgi/auto-upgrade-helper/tree/>`. 3058 :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`.
3062 3059
3063 Read through the sample file and make configurations as needed. For 3060 Read through the sample file and make configurations as needed. For
3064 example, if you enabled build history in your ``local.conf`` as 3061 example, if you enabled build history in your ``local.conf`` as
@@ -3122,7 +3119,7 @@ the layer tree.
3122 3119
3123You can easily set up to run the AUH utility on a regular basis by using 3120You can easily set up to run the AUH utility on a regular basis by using
3124a cron job. See the 3121a cron job. See the
3125:yocto_git:`weeklyjob.sh </cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh>` 3122:yocto_git:`weeklyjob.sh </auto-upgrade-helper/tree/weeklyjob.sh>`
3126file distributed with the utility for an example. 3123file distributed with the utility for an example.
3127 3124
3128Using ``devtool upgrade`` 3125Using ``devtool upgrade``
@@ -4362,9 +4359,9 @@ your tunings to best consider build times and package feed maintenance.
4362 higher levels noted earlier can be useful. For example, consider how 4359 higher levels noted earlier can be useful. For example, consider how
4363 NXP (formerly Freescale) allows for the easy reuse of binary packages 4360 NXP (formerly Freescale) allows for the easy reuse of binary packages
4364 in their layer 4361 in their layer
4365 :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/>`. 4362 :yocto_git:`meta-freescale </meta-freescale/>`.
4366 In this example, the 4363 In this example, the
4367 :yocto_git:`fsl-dynamic-packagearch </cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>` 4364 :yocto_git:`fsl-dynamic-packagearch </meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`
4368 class shares GPU packages for i.MX53 boards because all boards share 4365 class shares GPU packages for i.MX53 boards because all boards share
4369 the AMD GPU. The i.MX6-based boards can do the same because all 4366 the AMD GPU. The i.MX6-based boards can do the same because all
4370 boards share the Vivante GPU. This class inspects the BitBake 4367 boards share the Vivante GPU. This class inspects the BitBake
@@ -5564,7 +5561,7 @@ partition.
5564Source plugins are subclasses defined in plugin files. As shipped, the 5561Source plugins are subclasses defined in plugin files. As shipped, the
5565Yocto Project provides several plugin files. You can see the source 5562Yocto Project provides several plugin files. You can see the source
5566plugin files that ship with the Yocto Project 5563plugin files that ship with the Yocto Project
5567:yocto_git:`here </cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`. 5564:yocto_git:`here </poky/tree/scripts/lib/wic/plugins/source>`.
5568Each of these plugin files contains source plugins that are designed to 5565Each of these plugin files contains source plugins that are designed to
5569populate a specific Wic image partition. 5566populate a specific Wic image partition.
5570 5567
@@ -6175,7 +6172,7 @@ system to make your images more secure:
6175- Consider enabling a Mandatory Access Control (MAC) framework such as 6172- Consider enabling a Mandatory Access Control (MAC) framework such as
6176 SMACK or SELinux and tuning it appropriately for your device's usage. 6173 SMACK or SELinux and tuning it appropriately for your device's usage.
6177 You can find more information in the 6174 You can find more information in the
6178 :yocto_git:`meta-selinux </cgit/cgit.cgi/meta-selinux/>` layer. 6175 :yocto_git:`meta-selinux </meta-selinux/>` layer.
6179 6176
6180Tools for Hardening Your Image 6177Tools for Hardening Your Image
6181------------------------------ 6178------------------------------
@@ -8436,7 +8433,7 @@ might be significant in human-readable form. Here is an example:
8436 8433
8437To see changes to the build history using a web interface, follow the 8434To see changes to the build history using a web interface, follow the
8438instruction in the ``README`` file 8435instruction in the ``README`` file
8439:yocto_git:`here </cgit/cgit.cgi/buildhistory-web/>`. 8436:yocto_git:`here </buildhistory-web/>`.
8440 8437
8441Here is a sample screenshot of the interface: 8438Here is a sample screenshot of the interface:
8442 8439
@@ -9511,7 +9508,7 @@ the build system to run the task again.
9511 9508
9512 For an example of a commit that makes a cosmetic change to invalidate 9509 For an example of a commit that makes a cosmetic change to invalidate
9513 shared state, see this 9510 shared state, see this
9514 :yocto_git:`commit </cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`. 9511 :yocto_git:`commit </poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`.
9515 9512
9516Running Specific Tasks 9513Running Specific Tasks
9517---------------------- 9514----------------------
@@ -10475,7 +10472,7 @@ used testing branches for OpenEmbedded-Core are as follows:
10475 proposed changes to the core metadata. 10472 proposed changes to the core metadata.
10476 10473
10477- *poky "master-next" branch:* This branch is part of the 10474- *poky "master-next" branch:* This branch is part of the
10478 :yocto_git:`poky </cgit/cgit.cgi/poky/>` repository and combines proposed 10475 :yocto_git:`poky </poky/>` repository and combines proposed
10479 changes to bitbake, the core metadata and the poky distro. 10476 changes to bitbake, the core metadata and the poky distro.
10480 10477
10481Similarly, stable branches maintained by the project may have corresponding 10478Similarly, stable branches maintained by the project may have corresponding
@@ -11381,7 +11378,7 @@ this function, you have to follow the following steps:
11381 SPDX_DEPLOY_DIR = "${DEPLOY_DIR}" //Optional 11378 SPDX_DEPLOY_DIR = "${DEPLOY_DIR}" //Optional
11382 11379
11383For more usage information refer to :yocto_git:`the meta-spdxscanner repository 11380For more usage information refer to :yocto_git:`the meta-spdxscanner repository
11384</cgit/cgit.cgi/meta-spdxscanner/>`. 11381</meta-spdxscanner/>`.
11385 11382
11386 11383
11387Copying Licenses that Do Not Exist 11384Copying Licenses that Do Not Exist
@@ -11487,7 +11484,7 @@ Setting Up Your Own Error Reporting Server
11487------------------------------------------ 11484------------------------------------------
11488 11485
11489If you want to set up your own error reporting server, you can obtain 11486If you want to set up your own error reporting server, you can obtain
11490the code from the Git repository at :yocto_git:`/cgit/cgit.cgi/error-report-web/`. 11487the code from the Git repository at :yocto_git:`/error-report-web/`.
11491Instructions on how to set it up are in the README document. 11488Instructions on how to set it up are in the README document.
11492 11489
11493Using Wayland and Weston 11490Using Wayland and Weston