summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
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 /documentation/dev-manual
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>
Diffstat (limited to 'documentation/dev-manual')
-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
9 files changed, 26 insertions, 48 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...