summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-08 10:25:59 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commit01e5d22507e57c66452f14610ee8eb3d66ac9d71 (patch)
tree7241fa93a3a0d11db32d042e5d70a750132ab0a1
parent8b812b29c4b13ba028c0d66f73a6599a988486d5 (diff)
downloadpoky-01e5d22507e57c66452f14610ee8eb3d66ac9d71.tar.gz
manuals: fix double colons
Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/debugging.rst6
-rw-r--r--documentation/dev-manual/error-reporting-tool.rst3
-rw-r--r--documentation/dev-manual/licenses.rst3
-rw-r--r--documentation/dev-manual/new-recipe.rst16
-rw-r--r--documentation/dev-manual/qemu.rst20
-rw-r--r--documentation/dev-manual/quilt.rst3
-rw-r--r--documentation/dev-manual/runtime-testing.rst3
-rw-r--r--documentation/dev-manual/upgrading-recipes.rst14
-rw-r--r--documentation/dev-manual/wic.rst6
-rw-r--r--documentation/kernel-dev/advanced.rst15
-rw-r--r--documentation/kernel-dev/common.rst43
-rw-r--r--documentation/migration-guides/migration-2.2.rst12
-rw-r--r--documentation/ref-manual/devtool-reference.rst7
-rw-r--r--documentation/ref-manual/variables.rst36
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst3
-rw-r--r--documentation/sdk-manual/extensible.rst27
-rw-r--r--documentation/sdk-manual/using.rst21
-rw-r--r--documentation/sdk-manual/working-projects.rst15
18 files changed, 94 insertions, 159 deletions
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index ef296de7ac..f433e8e6a9 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -327,8 +327,7 @@ BitBake has determined by doing the following:
327 In the output of the above command, you will find a line like the 327 In the output of the above command, you will find a line like the
328 following, which lists all the (inferred) variable dependencies for 328 following, which lists all the (inferred) variable dependencies for
329 the task. This list also includes indirect dependencies from 329 the task. This list also includes indirect dependencies from
330 variables depending on other variables, recursively. 330 variables depending on other variables, recursively::
331 ::
332 331
333 Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[md5sum]', 'SRC_URI[sha256sum]', 'base_do_fetch'] 332 Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[md5sum]', 'SRC_URI[sha256sum]', 'base_do_fetch']
334 333
@@ -641,8 +640,7 @@ The syntax you use for recipes written in Bash is similar to that of
641recipes written in Python described in the previous section. 640recipes written in Python described in the previous section.
642 641
643Following is an example written in Bash. The code logs the progress of 642Following is an example written in Bash. The code logs the progress of
644the ``do_my_function`` function. 643the ``do_my_function`` function::
645::
646 644
647 do_my_function() { 645 do_my_function() {
648 bbdebug 2 "Running do_my_function" 646 bbdebug 2 "Running do_my_function"
diff --git a/documentation/dev-manual/error-reporting-tool.rst b/documentation/dev-manual/error-reporting-tool.rst
index a2636da37a..6854f1046a 100644
--- a/documentation/dev-manual/error-reporting-tool.rst
+++ b/documentation/dev-manual/error-reporting-tool.rst
@@ -71,8 +71,7 @@ Disabling the Tool
71 71
72To disable the error reporting feature, simply remove or comment out the 72To disable the error reporting feature, simply remove or comment out the
73following statement from the end of your ``local.conf`` file in your 73following statement from the end of your ``local.conf`` file in your
74:term:`Build Directory`. 74:term:`Build Directory`::
75::
76 75
77 INHERIT += "report-error" 76 INHERIT += "report-error"
78 77
diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
index 0db193f7e4..0f8d759519 100644
--- a/documentation/dev-manual/licenses.rst
+++ b/documentation/dev-manual/licenses.rst
@@ -154,8 +154,7 @@ or characters. A partial string will match any license that contains the
154given string as the first portion of its license. For example, the 154given string as the first portion of its license. For example, the
155following value will also match both of the packages 155following value will also match both of the packages
156previously mentioned as well as any other packages that have licenses 156previously mentioned as well as any other packages that have licenses
157starting with "commercial" or "license". 157starting with "commercial" or "license"::
158::
159 158
160 LICENSE_FLAGS_ACCEPTED = "commercial license" 159 LICENSE_FLAGS_ACCEPTED = "commercial license"
161 160
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index 2e9c2089f7..3adebf2746 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -109,8 +109,7 @@ Following are some syntax examples:
109 109
110 - Use this syntax to generate a recipe using code that 110 - Use this syntax to generate a recipe using code that
111 you extract from source. The extracted code is placed in its own layer 111 you extract from source. The extracted code is placed in its own layer
112 defined by :term:`EXTERNALSRC`. 112 defined by :term:`EXTERNALSRC`::
113 ::
114 113
115 recipetool create -o OUTFILE -x EXTERNALSRC source 114 recipetool create -o OUTFILE -x EXTERNALSRC source
116 115
@@ -147,8 +146,7 @@ get started. Here are some points on both methods:
147- *Use and modify the following skeleton recipe:* If for some reason 146- *Use and modify the following skeleton recipe:* If for some reason
148 you do not want to use ``recipetool`` and you cannot find an existing 147 you do not want to use ``recipetool`` and you cannot find an existing
149 recipe that is close to meeting your needs, you can use the following 148 recipe that is close to meeting your needs, you can use the following
150 structure to provide the fundamental areas of a new recipe. 149 structure to provide the fundamental areas of a new recipe::
151 ::
152 150
153 DESCRIPTION = "" 151 DESCRIPTION = ""
154 HOMEPAGE = "" 152 HOMEPAGE = ""
@@ -347,9 +345,7 @@ paste them into your recipe and then run the build again to continue.
347This final example is a bit more complicated and is from the 345This final example is a bit more complicated and is from the
348``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The 346``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The
349example's :term:`SRC_URI` statement identifies multiple files as the source 347example's :term:`SRC_URI` statement identifies multiple files as the source
350files for the recipe: a tarball, a patch file, a desktop file, and an 348files for the recipe: a tarball, a patch file, a desktop file, and an icon::
351icon.
352::
353 349
354 SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \ 350 SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \
355 file://xwc.patch \ 351 file://xwc.patch \
@@ -1196,8 +1192,7 @@ under ``files``) requires a recipe that has the file listed in the
1196:ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the 1192:ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the
1197directory containing the source code, which is set to 1193directory containing the source code, which is set to
1198:term:`WORKDIR` in this case --- the 1194:term:`WORKDIR` in this case --- the
1199directory BitBake uses for the build. 1195directory BitBake uses for the build::
1200::
1201 1196
1202 SUMMARY = "Simple helloworld application" 1197 SUMMARY = "Simple helloworld application"
1203 SECTION = "examples" 1198 SECTION = "examples"
@@ -1233,8 +1228,7 @@ which contains the definitions of all the steps needed to build an
1233Autotool-based application. The result of the build is automatically 1228Autotool-based application. The result of the build is automatically
1234packaged. And, if the application uses NLS for localization, packages 1229packaged. And, if the application uses NLS for localization, packages
1235with local information are generated (one package per language). 1230with local information are generated (one package per language).
1236Following is one example: (``hello_2.3.bb``) 1231Following is one example: (``hello_2.3.bb``)::
1237::
1238 1232
1239 SUMMARY = "GNU Helloworld application" 1233 SUMMARY = "GNU Helloworld application"
1240 SECTION = "examples" 1234 SECTION = "examples"
diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 504fcbdd8d..084e67580d 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -103,7 +103,9 @@ available. Follow these general steps to run QEMU:
103 automatically finds the ``bzImage-qemux86-64.bin`` image file and 103 automatically finds the ``bzImage-qemux86-64.bin`` image file and
104 the ``core-image-minimal-qemux86-64-20200218002850.rootfs.ext4`` 104 the ``core-image-minimal-qemux86-64-20200218002850.rootfs.ext4``
105 (assuming the current build created a ``core-image-minimal`` 105 (assuming the current build created a ``core-image-minimal``
106 image). 106 image)::
107
108 $ runqemu qemux86-64
107 109
108 .. note:: 110 .. note::
109 111
@@ -111,14 +113,9 @@ available. Follow these general steps to run QEMU:
111 and uses the most recently built image according to the 113 and uses the most recently built image according to the
112 timestamp. 114 timestamp.
113 115
114 ::
115
116 $ runqemu qemux86-64
117
118 - This example produces the exact same results as the previous 116 - This example produces the exact same results as the previous
119 example. This command, however, specifically provides the image 117 example. This command, however, specifically provides the image
120 and root filesystem type. 118 and root filesystem type::
121 ::
122 119
123 $ runqemu qemux86-64 core-image-minimal ext4 120 $ runqemu qemux86-64 core-image-minimal ext4
124 121
@@ -127,23 +124,20 @@ available. Follow these general steps to run QEMU:
127 variable ``FSTYPE`` to ``cpio.gz``. Also, for audio to be enabled, 124 variable ``FSTYPE`` to ``cpio.gz``. Also, for audio to be enabled,
128 an appropriate driver must be installed (see the ``audio`` option 125 an appropriate driver must be installed (see the ``audio`` option
129 in :ref:`dev-manual/qemu:\`\`runqemu\`\` command-line options` 126 in :ref:`dev-manual/qemu:\`\`runqemu\`\` command-line options`
130 for more information). 127 for more information)::
131 ::
132 128
133 $ runqemu qemux86-64 ramfs audio 129 $ runqemu qemux86-64 ramfs audio
134 130
135 - This example does not provide enough information for QEMU to 131 - This example does not provide enough information for QEMU to
136 launch. While the command does provide a root filesystem type, it 132 launch. While the command does provide a root filesystem type, it
137 must also minimally provide a `MACHINE`, `KERNEL`, or `VM` option. 133 must also minimally provide a `MACHINE`, `KERNEL`, or `VM` option::
138 ::
139 134
140 $ runqemu ext4 135 $ runqemu ext4
141 136
142 - This example specifies to boot a virtual machine image 137 - This example specifies to boot a virtual machine image
143 (``.wic.vmdk`` file). From the ``.wic.vmdk``, ``runqemu`` 138 (``.wic.vmdk`` file). From the ``.wic.vmdk``, ``runqemu``
144 determines the QEMU architecture (`MACHINE`) to be "qemux86-64" and 139 determines the QEMU architecture (`MACHINE`) to be "qemux86-64" and
145 the root filesystem type to be "vmdk". 140 the root filesystem type to be "vmdk"::
146 ::
147 141
148 $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk 142 $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk
149 143
diff --git a/documentation/dev-manual/quilt.rst b/documentation/dev-manual/quilt.rst
index d1b605bcd5..1dd9ff02d4 100644
--- a/documentation/dev-manual/quilt.rst
+++ b/documentation/dev-manual/quilt.rst
@@ -67,8 +67,7 @@ Follow these general steps:
67 67
687. *Generate the Patch:* Once your changes work as expected, you need to 687. *Generate the Patch:* Once your changes work as expected, you need to
69 use Quilt to generate the final patch that contains all your 69 use Quilt to generate the final patch that contains all your
70 modifications. 70 modifications::
71 ::
72 71
73 $ quilt refresh 72 $ quilt refresh
74 73
diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst
index 24f3dd1511..88b3ed541b 100644
--- a/documentation/dev-manual/runtime-testing.rst
+++ b/documentation/dev-manual/runtime-testing.rst
@@ -578,8 +578,7 @@ data:
578 578
579Following is an example JSON file that handles test "foo" installing 579Following is an example JSON file that handles test "foo" installing
580package "bar" and test "foobar" installing packages "foo" and "bar". 580package "bar" and test "foobar" installing packages "foo" and "bar".
581Once the test is complete, the packages are removed from the DUT. 581Once the test is complete, the packages are removed from the DUT::
582::
583 582
584 { 583 {
585 "foo": { 584 "foo": {
diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst
index a0856f43da..c41e3e1a5d 100644
--- a/documentation/dev-manual/upgrading-recipes.rst
+++ b/documentation/dev-manual/upgrading-recipes.rst
@@ -260,14 +260,7 @@ your build configuration (i.e. ``${BUILDDIR}/conf/bblayers.conf``)::
260For this example, assume that the ``nano.bb`` recipe that 260For this example, assume that the ``nano.bb`` recipe that
261is upstream has a 2.9.3 version number. However, the version in the 261is upstream has a 2.9.3 version number. However, the version in the
262local repository is 2.7.4. The following command from your build 262local repository is 2.7.4. The following command from your build
263directory automatically upgrades the recipe for you: 263directory automatically upgrades the recipe for you::
264
265.. note::
266
267 Using the ``-V`` option is not necessary. Omitting the version number causes
268 ``devtool upgrade`` to upgrade the recipe to the most recent version.
269
270::
271 264
272 $ devtool upgrade nano -V 2.9.3 265 $ devtool upgrade nano -V 2.9.3
273 NOTE: Starting bitbake server... 266 NOTE: Starting bitbake server...
@@ -286,6 +279,11 @@ directory automatically upgrades the recipe for you:
286 NOTE: Upgraded source extracted to /home/scottrif/poky/build/workspace/sources/nano 279 NOTE: Upgraded source extracted to /home/scottrif/poky/build/workspace/sources/nano
287 NOTE: New recipe is /home/scottrif/poky/build/workspace/recipes/nano/nano_2.9.3.bb 280 NOTE: New recipe is /home/scottrif/poky/build/workspace/recipes/nano/nano_2.9.3.bb
288 281
282.. note::
283
284 Using the ``-V`` option is not necessary. Omitting the version number causes
285 ``devtool upgrade`` to upgrade the recipe to the most recent version.
286
289Continuing with this example, you can use ``devtool build`` to build the 287Continuing with this example, you can use ``devtool build`` to build the
290newly upgraded recipe:: 288newly upgraded recipe::
291 289
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index d2f7bd0130..7ed887b270 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -539,8 +539,7 @@ will need to boot from ``sdb`` instead of ``sda``, which is what the
539 539
540The example begins by making a copy of the ``directdisk-gpt.wks`` file 540The example begins by making a copy of the ``directdisk-gpt.wks`` file
541in the ``scripts/lib/image/canned-wks`` directory and then by changing 541in the ``scripts/lib/image/canned-wks`` directory and then by changing
542the lines that specify the target disk from which to boot. 542the lines that specify the target disk from which to boot::
543::
544 543
545 $ cp /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ 544 $ cp /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisk-gpt.wks \
546 /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks 545 /home/stephano/yocto/poky/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks
@@ -557,8 +556,7 @@ Once the lines are changed, the
557example generates the ``directdisksdb-gpt`` image. The command points 556example generates the ``directdisksdb-gpt`` image. The command points
558the process at the ``core-image-minimal`` artifacts for the Next Unit of 557the process at the ``core-image-minimal`` artifacts for the Next Unit of
559Computing (nuc) :term:`MACHINE` the 558Computing (nuc) :term:`MACHINE` the
560``local.conf``. 559``local.conf``::
561::
562 560
563 $ wic create directdisksdb-gpt -e core-image-minimal 561 $ wic create directdisksdb-gpt -e core-image-minimal
564 INFO: Building wic-tools... 562 INFO: Building wic-tools...
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index b16b3e0517..a8734900a0 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -566,15 +566,7 @@ Example
566Many real-world examples are more complex. Like any other ``.scc`` file, 566Many real-world examples are more complex. Like any other ``.scc`` file,
567BSP descriptions can aggregate features. Consider the Minnow BSP 567BSP descriptions can aggregate features. Consider the Minnow BSP
568definition given the ``linux-yocto-4.4`` branch of the 568definition given the ``linux-yocto-4.4`` branch of the
569``yocto-kernel-cache`` (i.e. 569``yocto-kernel-cache`` (i.e. ``yocto-kernel-cache/bsp/minnow/minnow.scc``)::
570``yocto-kernel-cache/bsp/minnow/minnow.scc``):
571
572.. note::
573
574 Although the Minnow Board BSP is unused, the Metadata remains and is
575 being used here just as an example.
576
577::
578 570
579 include cfg/x86.scc 571 include cfg/x86.scc
580 include features/eg20t/eg20t.scc 572 include features/eg20t/eg20t.scc
@@ -597,6 +589,11 @@ definition given the ``linux-yocto-4.4`` branch of the
597 kconf hardware minnow.cfg 589 kconf hardware minnow.cfg
598 kconf hardware minnow-dev.cfg 590 kconf hardware minnow-dev.cfg
599 591
592.. note::
593
594 Although the Minnow Board BSP is unused, the Metadata remains and is
595 being used here just as an example.
596
600The ``minnow.scc`` description file includes a hardware configuration 597The ``minnow.scc`` description file includes a hardware configuration
601fragment (``minnow.cfg``) specific to the Minnow BSP as well as several 598fragment (``minnow.cfg``) specific to the Minnow BSP as well as several
602more general configuration fragments and features enabling hardware 599more general configuration fragments and features enabling hardware
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index e9660dd4e6..c4c1f629a6 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -166,8 +166,7 @@ section:
166 checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If 166 checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If
167 you need to checkout out the &DISTRO_NAME; branch, see the 167 you need to checkout out the &DISTRO_NAME; branch, see the
168 ":ref:`dev-manual/start:checking out by branch in poky`" 168 ":ref:`dev-manual/start:checking out by branch in poky`"
169 section in the Yocto Project Development Tasks Manual. 169 section in the Yocto Project Development Tasks Manual::
170 ::
171 170
172 $ cd poky 171 $ cd poky
173 $ git branch 172 $ git branch
@@ -244,16 +243,7 @@ section:
244 ``standard/base`` branch. 243 ``standard/base`` branch.
245 244
246 The following commands show how to create a local copy of the 245 The following commands show how to create a local copy of the
247 ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch. 246 ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch::
248
249 .. note::
250
251 The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4
252 release and forward.
253 You cannot use the ``linux-yocto-4.12`` kernel with releases prior to
254 Yocto Project 2.4.
255
256 ::
257 247
258 $ cd ~ 248 $ cd ~
259 $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base 249 $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base
@@ -265,6 +255,13 @@ section:
265 Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done. 255 Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done.
266 Checking out files: 100% (59846/59846), done. 256 Checking out files: 100% (59846/59846), done.
267 257
258 .. note::
259
260 The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4
261 release and forward.
262 You cannot use the ``linux-yocto-4.12`` kernel with releases prior to
263 Yocto Project 2.4.
264
2686. *Create a Local Copy of the Kernel Cache Git Repository:* For 2656. *Create a Local Copy of the Kernel Cache Git Repository:* For
269 simplicity, it is recommended that you create your copy of the kernel 266 simplicity, it is recommended that you create your copy of the kernel
270 cache Git repository outside of the 267 cache Git repository outside of the
@@ -428,8 +425,7 @@ As an example, consider the following append file used by the BSPs in
428 425
429Here are the contents of this file. Be aware that the actual commit ID 426Here are the contents of this file. Be aware that the actual commit ID
430strings in this example listing might be different than the actual 427strings in this example listing might be different than the actual
431strings in the file from the ``meta-yocto-bsp`` layer upstream. 428strings in the file from the ``meta-yocto-bsp`` layer upstream::
432::
433 429
434 KBRANCH:genericx86 = "standard/base" 430 KBRANCH:genericx86 = "standard/base"
435 KBRANCH:genericx86-64 = "standard/base" 431 KBRANCH:genericx86-64 = "standard/base"
@@ -490,8 +486,7 @@ For example, suppose you had some configuration options in a file called
490``network_configs.cfg``. You can place that file inside a directory 486``network_configs.cfg``. You can place that file inside a directory
491named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the 487named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the
492following to the append file. When the OpenEmbedded build system builds 488following to the append file. When the OpenEmbedded build system builds
493the kernel, the configuration options are picked up and applied. 489the kernel, the configuration options are picked up and applied::
494::
495 490
496 SRC_URI += "file://network_configs.cfg" 491 SRC_URI += "file://network_configs.cfg"
497 492
@@ -766,7 +761,10 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
766 761
7674. *Create the Image With the New Kernel:* Use the 7624. *Create the Image With the New Kernel:* Use the
768 ``devtool build-image`` command to create a new image that has the 763 ``devtool build-image`` command to create a new image that has the
769 new kernel. 764 new kernel::
765
766 $ cd ~
767 $ devtool build-image core-image-minimal
770 768
771 .. note:: 769 .. note::
772 770
@@ -776,11 +774,6 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
776 :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` 774 :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>`
777 Wiki Page. 775 Wiki Page.
778 776
779 ::
780
781 $ cd ~
782 $ devtool build-image core-image-minimal
783
7845. *Test the New Image:* For this example, you can run the new image 7775. *Test the New Image:* For this example, you can run the new image
785 using QEMU to verify your changes: 778 using QEMU to verify your changes:
786 779
@@ -812,8 +805,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
812 805
8137. *Export the Patches and Create an Append File:* To export your 8067. *Export the Patches and Create an Append File:* To export your
814 commits as patches and create a ``.bbappend`` file, use the following 807 commits as patches and create a ``.bbappend`` file, use the following
815 command. This example uses the previously established layer named ``meta-mylayer``. 808 command. This example uses the previously established layer named ``meta-mylayer``::
816 ::
817 809
818 $ devtool finish linux-yocto ~/meta-mylayer 810 $ devtool finish linux-yocto ~/meta-mylayer
819 811
@@ -1760,8 +1752,7 @@ Here is an example that looks at what has changed in the ``emenlow``
1760branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the 1752branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the
1761commit associated with the ``standard/base`` branch, while the upper 1753commit associated with the ``standard/base`` branch, while the upper
1762commit range is the commit associated with the ``standard/emenlow`` 1754commit range is the commit associated with the ``standard/emenlow``
1763branch. 1755branch::
1764::
1765 1756
1766 $ git whatchanged origin/standard/base..origin/standard/emenlow 1757 $ git whatchanged origin/standard/base..origin/standard/emenlow
1767 1758
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index 82c8e52df5..751fa06ee8 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -184,13 +184,7 @@ root filesystem, provides an image, and uses the ``nographic`` option::
184 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic 184 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
185 185
186Following is a list of variables that can be set in configuration files 186Following is a list of variables that can be set in configuration files
187such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``: 187such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``::
188
189.. note::
190
191 "QB" means "QEMU Boot".
192
193::
194 188
195 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") 189 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
196 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") 190 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
@@ -225,6 +219,10 @@ follows and run ``runqemu``:
225 219
226.. note:: 220.. note::
227 221
222 "QB" means "QEMU Boot".
223
224.. note::
225
228 For command-line syntax, use ``runqemu help``. 226 For command-line syntax, use ``runqemu help``.
229 227
230:: 228::
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index c2e1c2c29b..6aa09f6d6f 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -385,9 +385,7 @@ want to use it because the dependency on ``cdebconf`` is not easily
385satisfied. Maintainers can explicit the reason that is shown by adding 385satisfied. Maintainers can explicit the reason that is shown by adding
386the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. 386the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
387See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` 387See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
388for an example. 388for an example::
389
390::
391 389
392 $ devtool check-upgrade-status 390 $ devtool check-upgrade-status
393 ... 391 ...
@@ -555,8 +553,7 @@ Use the ``devtool undeploy-target`` command to remove deployed build
555output from the target machine. For the ``devtool undeploy-target`` 553output from the target machine. For the ``devtool undeploy-target``
556command to work, you must have previously used the 554command to work, you must have previously used the
557":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`" 555":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`"
558command. 556command::
559::
560 557
561 $ devtool undeploy-target recipe target 558 $ devtool undeploy-target recipe target
562 559
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 99100498b7..3190020aaf 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -250,8 +250,7 @@ system and gives an overview of their function and contents.
250 Azure Storage Shared Access Signature, when using the 250 Azure Storage Shared Access Signature, when using the
251 :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` 251 :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
252 This variable can be defined to be used by the fetcher to authenticate 252 This variable can be defined to be used by the fetcher to authenticate
253 and gain access to non-public artifacts. 253 and gain access to non-public artifacts::
254 ::
255 254
256 AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"" 255 AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>""
257 256
@@ -324,8 +323,7 @@ system and gives an overview of their function and contents.
324 323
325 - There is limited support for wildcard matching against the beginning of 324 - There is limited support for wildcard matching against the beginning of
326 host names. For example, the following setting matches 325 host names. For example, the following setting matches
327 ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. 326 ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``::
328 ::
329 327
330 BB_ALLOWED_NETWORKS = "*.gnu.org" 328 BB_ALLOWED_NETWORKS = "*.gnu.org"
331 329
@@ -529,8 +527,7 @@ system and gives an overview of their function and contents.
529 527
530 For performance reasons, creating and placing tarballs of these 528 For performance reasons, creating and placing tarballs of these
531 repositories is not the default action by the OpenEmbedded build 529 repositories is not the default action by the OpenEmbedded build
532 system. 530 system::
533 ::
534 531
535 BB_GENERATE_MIRROR_TARBALLS = "1" 532 BB_GENERATE_MIRROR_TARBALLS = "1"
536 533
@@ -3020,8 +3017,7 @@ system and gives an overview of their function and contents.
3020 :term:`IMAGE_LINGUAS` appropriately. 3017 :term:`IMAGE_LINGUAS` appropriately.
3021 3018
3022 You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file. 3019 You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file.
3023 By default, all locales are generated. 3020 By default, all locales are generated::
3024 ::
3025 3021
3026 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" 3022 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
3027 3023
@@ -5889,8 +5885,7 @@ system and gives an overview of their function and contents.
5889 5885
5890 Consider the following :term:`PACKAGECONFIG` block taken from the 5886 Consider the following :term:`PACKAGECONFIG` block taken from the
5891 ``librsvg`` recipe. In this example the feature is ``gtk``, which has 5887 ``librsvg`` recipe. In this example the feature is ``gtk``, which has
5892 three arguments that determine the feature's behavior. 5888 three arguments that determine the feature's behavior::
5893 ::
5894 5889
5895 PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" 5890 PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3"
5896 5891
@@ -7821,8 +7816,7 @@ system and gives an overview of their function and contents.
7821 If a mirror uses the same structure as 7816 If a mirror uses the same structure as
7822 :term:`SSTATE_DIR`, you need to add "PATH" at the 7817 :term:`SSTATE_DIR`, you need to add "PATH" at the
7823 end as shown in the examples below. The build system substitutes the 7818 end as shown in the examples below. The build system substitutes the
7824 correct path within the directory structure. 7819 correct path within the directory structure::
7825 ::
7826 7820
7827 SSTATE_MIRRORS ?= "\ 7821 SSTATE_MIRRORS ?= "\
7828 file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \ 7822 file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \
@@ -8616,8 +8610,7 @@ system and gives an overview of their function and contents.
8616 8610
8617 Alternatively, you can 8611 Alternatively, you can
8618 provide the "auto" option to have all applicable tests run against 8612 provide the "auto" option to have all applicable tests run against
8619 the image. 8613 the image::
8620 ::
8621 8614
8622 TEST_SUITES:append = " auto" 8615 TEST_SUITES:append = " auto"
8623 8616
@@ -9115,8 +9108,7 @@ system and gives an overview of their function and contents.
9115 releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS` 9108 releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS`
9116 to ``1`` in the recipe, and the OpenEmbedded build system 9109 to ``1`` in the recipe, and the OpenEmbedded build system
9117 will compare the latest commit with the one currently specified 9110 will compare the latest commit with the one currently specified
9118 by the recipe (:term:`SRCREV`). 9111 by the recipe (:term:`SRCREV`)::
9119 ::
9120 9112
9121 UPSTREAM_CHECK_COMMITS = "1" 9113 UPSTREAM_CHECK_COMMITS = "1"
9122 9114
@@ -9129,8 +9121,7 @@ system and gives an overview of their function and contents.
9129 9121
9130 You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a 9122 You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a
9131 regular expression to filter only the relevant tags should the 9123 regular expression to filter only the relevant tags should the
9132 default filter not work correctly. 9124 default filter not work correctly::
9133 ::
9134 9125
9135 UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" 9126 UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
9136 9127
@@ -9138,8 +9129,7 @@ system and gives an overview of their function and contents.
9138 Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different 9129 Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different
9139 regular expression instead of the default one when the package 9130 regular expression instead of the default one when the package
9140 checking system is parsing the page found using 9131 checking system is parsing the page found using
9141 :term:`UPSTREAM_CHECK_URI`. 9132 :term:`UPSTREAM_CHECK_URI`::
9142 ::
9143 9133
9144 UPSTREAM_CHECK_REGEX = "package_regex" 9134 UPSTREAM_CHECK_REGEX = "package_regex"
9145 9135
@@ -9150,8 +9140,7 @@ system and gives an overview of their function and contents.
9150 determined by fetching the directory listing where the tarball is and 9140 determined by fetching the directory listing where the tarball is and
9151 attempting to find a later tarball. When this approach does not work, 9141 attempting to find a later tarball. When this approach does not work,
9152 you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that 9142 you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that
9153 contains the link to the latest tarball. 9143 contains the link to the latest tarball::
9154 ::
9155 9144
9156 UPSTREAM_CHECK_URI = "recipe_url" 9145 UPSTREAM_CHECK_URI = "recipe_url"
9157 9146
@@ -9162,8 +9151,7 @@ system and gives an overview of their function and contents.
9162 :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in 9151 :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in
9163 the recipe allows to determine what the latest upstream version is, 9152 the recipe allows to determine what the latest upstream version is,
9164 you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe 9153 you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe
9165 to acknowledge that the check cannot be performed. 9154 to acknowledge that the check cannot be performed::
9166 ::
9167 9155
9168 UPSTREAM_VERSION_UNKNOWN = "1" 9156 UPSTREAM_VERSION_UNKNOWN = "1"
9169 9157
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index b90247d2e0..fa82af5c22 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -111,8 +111,7 @@ build the SDK installer. Follow these steps:
111 the Source Directory (i.e. ``poky``), run the 111 the Source Directory (i.e. ``poky``), run the
112 :ref:`structure-core-script` environment 112 :ref:`structure-core-script` environment
113 setup script to define the OpenEmbedded build environment on your 113 setup script to define the OpenEmbedded build environment on your
114 build host. 114 build host::
115 ::
116 115
117 $ source oe-init-build-env 116 $ source oe-init-build-env
118 117
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 4d36270e64..7ab43e0a9d 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -138,16 +138,7 @@ must be writable for whichever users need to use the SDK.
138The following command shows how to run the installer given a toolchain 138The following command shows how to run the installer given a toolchain
139tarball for a 64-bit x86 development host system and a 64-bit x86 target 139tarball for a 64-bit x86 development host system and a 64-bit x86 target
140architecture. The example assumes the SDK installer is located in 140architecture. The example assumes the SDK installer is located in
141``~/Downloads/`` and has execution rights. 141``~/Downloads/`` and has execution rights::
142
143.. note::
144
145 If you do not have write permissions for the directory into which you
146 are installing the SDK, the installer notifies you and exits. For
147 that case, set up the proper permissions in the directory and run the
148 installer again.
149
150::
151 142
152 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh 143 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh
153 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5 144 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
@@ -168,6 +159,13 @@ architecture. The example assumes the SDK installer is located in
168 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 159 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
169 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux 160 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux
170 161
162.. note::
163
164 If you do not have write permissions for the directory into which you
165 are installing the SDK, the installer notifies you and exits. For
166 that case, set up the proper permissions in the directory and run the
167 installer again.
168
171Running the Extensible SDK Environment Setup Script 169Running the Extensible SDK Environment Setup Script
172=================================================== 170===================================================
173 171
@@ -406,8 +404,7 @@ command:
406 creates any patches corresponding to commits in the local Git 404 creates any patches corresponding to commits in the local Git
407 repository, moves the new recipe to a more permanent layer, and then 405 repository, moves the new recipe to a more permanent layer, and then
408 resets the recipe so that the recipe is built normally rather than 406 resets the recipe so that the recipe is built normally rather than
409 from the workspace. 407 from the workspace::
410 ::
411 408
412 $ devtool finish recipe layer 409 $ devtool finish recipe layer
413 410
@@ -605,8 +602,7 @@ command:
605 repository, updates the recipe to point to them (or creates a 602 repository, updates the recipe to point to them (or creates a
606 ``.bbappend`` file to do so, depending on the specified destination 603 ``.bbappend`` file to do so, depending on the specified destination
607 layer), and then resets the recipe so that the recipe is built 604 layer), and then resets the recipe so that the recipe is built
608 normally rather than from the workspace. 605 normally rather than from the workspace::
609 ::
610 606
611 $ devtool finish recipe layer 607 $ devtool finish recipe layer
612 608
@@ -780,8 +776,7 @@ The following diagram shows the common development flow used with the
780 776
781 If you specify a destination layer that is the same as the original 777 If you specify a destination layer that is the same as the original
782 source, then the old version of the recipe and associated files are 778 source, then the old version of the recipe and associated files are
783 removed prior to adding the new version. 779 removed prior to adding the new version::
784 ::
785 780
786 $ devtool finish recipe layer 781 $ devtool finish recipe layer
787 782
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst
index 301627812c..f1ff0c76ca 100644
--- a/documentation/sdk-manual/using.rst
+++ b/documentation/sdk-manual/using.rst
@@ -52,8 +52,7 @@ libraries appropriate for developing against the corresponding image.
52 52
53The names of the tarball installer scripts are such that a string 53The names of the tarball installer scripts are such that a string
54representing the host system appears first in the filename and then is 54representing the host system appears first in the filename and then is
55immediately followed by a string representing the target architecture. 55immediately followed by a string representing the target architecture::
56::
57 56
58 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh 57 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
59 58
@@ -97,16 +96,7 @@ must be writable for whichever users need to use the SDK.
97The following command shows how to run the installer given a toolchain 96The following command shows how to run the installer given a toolchain
98tarball for a 64-bit x86 development host system and a 64-bit x86 target 97tarball for a 64-bit x86 development host system and a 64-bit x86 target
99architecture. The example assumes the SDK installer is located in 98architecture. The example assumes the SDK installer is located in
100``~/Downloads/`` and has execution rights. 99``~/Downloads/`` and has execution rights::
101
102.. note::
103
104 If you do not have write permissions for the directory into which you
105 are installing the SDK, the installer notifies you and exits. For
106 that case, set up the proper permissions in the directory and run the
107 installer again.
108
109::
110 100
111 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh 101 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
112 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; 102 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
@@ -119,6 +109,13 @@ architecture. The example assumes the SDK installer is located in
119 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 109 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
120 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux 110 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
121 111
112.. note::
113
114 If you do not have write permissions for the directory into which you
115 are installing the SDK, the installer notifies you and exits. For
116 that case, set up the proper permissions in the directory and run the
117 installer again.
118
122Again, reference the 119Again, reference the
123":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`" 120":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
124section for more details on the resulting directory structure of the installed 121section for more details on the resulting directory structure of the installed
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index 0eddee08e3..beec1dd09a 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -33,8 +33,7 @@ project:
33 33
341. *Create a Working Directory and Populate It:* Create a clean 341. *Create a Working Directory and Populate It:* Create a clean
35 directory for your project and then make that directory your working 35 directory for your project and then make that directory your working
36 location. 36 location::
37 ::
38 37
39 $ mkdir $HOME/helloworld 38 $ mkdir $HOME/helloworld
40 $ cd $HOME/helloworld 39 $ cd $HOME/helloworld
@@ -146,8 +145,7 @@ project:
146 This next command is a simple way to verify the installation of your 145 This next command is a simple way to verify the installation of your
147 project. Running the command prints the architecture on which the 146 project. Running the command prints the architecture on which the
148 binary file can run. This architecture should be the same 147 binary file can run. This architecture should be the same
149 architecture that the installed cross-toolchain supports. 148 architecture that the installed cross-toolchain supports::
150 ::
151 149
152 $ file ./tmp/usr/local/bin/hello 150 $ file ./tmp/usr/local/bin/hello
153 151
@@ -210,8 +208,7 @@ demonstrates these variable behaviors.
210In a new shell environment variables are not established for the SDK 208In a new shell environment variables are not established for the SDK
211until you run the setup script. For example, the following commands show 209until you run the setup script. For example, the following commands show
212a null value for the compiler variable (i.e. 210a null value for the compiler variable (i.e.
213:term:`CC`). 211:term:`CC`)::
214::
215 212
216 $ echo ${CC} 213 $ echo ${CC}
217 214
@@ -232,8 +229,7 @@ example:
232 229
2331. *Create a Working Directory and Populate It:* Create a clean 2301. *Create a Working Directory and Populate It:* Create a clean
234 directory for your project and then make that directory your working 231 directory for your project and then make that directory your working
235 location. 232 location::
236 ::
237 233
238 $ mkdir $HOME/helloworld 234 $ mkdir $HOME/helloworld
239 $ cd $HOME/helloworld 235 $ cd $HOME/helloworld
@@ -322,8 +318,7 @@ example:
322 318
323 You can override the :term:`CC` environment variable with the same 319 You can override the :term:`CC` environment variable with the same
324 variable as set from the Makefile by uncommenting the line in the 320 variable as set from the Makefile by uncommenting the line in the
325 Makefile and running ``make`` again. 321 Makefile and running ``make`` again::
326 ::
327 322
328 $ make clean 323 $ make clean
329 rm -rf *.o 324 rm -rf *.o