summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/building.rst2
-rw-r--r--documentation/dev-manual/debugging.rst8
-rw-r--r--documentation/dev-manual/development-shell.rst2
-rw-r--r--documentation/dev-manual/layers.rst8
-rw-r--r--documentation/dev-manual/libraries.rst4
-rw-r--r--documentation/dev-manual/licenses.rst2
-rw-r--r--documentation/dev-manual/new-machine.rst2
-rw-r--r--documentation/dev-manual/new-recipe.rst8
-rw-r--r--documentation/dev-manual/packages.rst4
-rw-r--r--documentation/dev-manual/prebuilt-libraries.rst4
-rw-r--r--documentation/dev-manual/python-development-shell.rst2
-rw-r--r--documentation/dev-manual/qemu.rst4
-rw-r--r--documentation/dev-manual/runtime-testing.rst4
-rw-r--r--documentation/dev-manual/speeding-up-build.rst4
-rw-r--r--documentation/dev-manual/start.rst6
15 files changed, 32 insertions, 32 deletions
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index e964bd1aee..7fcac33b75 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -160,7 +160,7 @@ Follow these steps to set up and execute multiple configuration builds:
160 The location for these multiconfig configuration files is specific. 160 The location for these multiconfig configuration files is specific.
161 They must reside in the current :term:`Build Directory` in a sub-directory of 161 They must reside in the current :term:`Build Directory` in a sub-directory of
162 ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory 162 ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory
163 under a directory named ``multiconfig``. Following is an example that defines 163 under a directory named ``multiconfig``. Here is an example that defines
164 two configuration files for the "x86" and "arm" multiconfigs: 164 two configuration files for the "x86" and "arm" multiconfigs:
165 165
166 .. image:: figures/multiconfig_files.png 166 .. image:: figures/multiconfig_files.png
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index bd1e716b0b..71b5807f5a 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -170,7 +170,7 @@ You can use the ``oe-pkgdata-util`` command-line utility to query
170various package-related information. When you use the utility, you must 170various package-related information. When you use the utility, you must
171use it to view information on packages that have already been built. 171use it to view information on packages that have already been built.
172 172
173Following are a few of the available ``oe-pkgdata-util`` subcommands. 173Here are a few of the available ``oe-pkgdata-util`` subcommands.
174 174
175.. note:: 175.. note::
176 176
@@ -608,7 +608,7 @@ logs, keep in mind the goal is to have informative logs while keeping
608the console as "silent" as possible. Also, if you want status messages 608the console as "silent" as possible. Also, if you want status messages
609in the log, use the "debug" loglevel. 609in the log, use the "debug" loglevel.
610 610
611Following is an example written in Python. The code handles logging for 611Here is an example written in Python. The code handles logging for
612a function that determines the number of tasks needed to be run. See the 612a function that determines the number of tasks needed to be run. See the
613":ref:`ref-tasks-listtasks`" 613":ref:`ref-tasks-listtasks`"
614section for additional information:: 614section for additional information::
@@ -636,7 +636,7 @@ logs, you have the same goals --- informative with minimal console output.
636The syntax you use for recipes written in Bash is similar to that of 636The syntax you use for recipes written in Bash is similar to that of
637recipes written in Python described in the previous section. 637recipes written in Python described in the previous section.
638 638
639Following is an example written in Bash. The code logs the progress of 639Here is an example written in Bash. The code logs the progress of
640the ``do_my_function`` function:: 640the ``do_my_function`` function::
641 641
642 do_my_function() { 642 do_my_function() {
@@ -1221,7 +1221,7 @@ Here are some other tips that you might find useful:
1221 "$@" 1221 "$@"
1222 } 1222 }
1223 1223
1224 Following are some usage examples:: 1224 Here are some usage examples::
1225 1225
1226 $ g FOO # Search recursively for "FOO" 1226 $ g FOO # Search recursively for "FOO"
1227 $ g -i foo # Search recursively for "foo", ignoring case 1227 $ g -i foo # Search recursively for "foo", ignoring case
diff --git a/documentation/dev-manual/development-shell.rst b/documentation/dev-manual/development-shell.rst
index a18d792150..be26bcffc7 100644
--- a/documentation/dev-manual/development-shell.rst
+++ b/documentation/dev-manual/development-shell.rst
@@ -16,7 +16,7 @@ OpenEmbedded build system were executing them. Consequently, working
16this way can be helpful when debugging a build or preparing software to 16this way can be helpful when debugging a build or preparing software to
17be used with the OpenEmbedded build system. 17be used with the OpenEmbedded build system.
18 18
19Following is an example that uses ``devshell`` on a target named 19Here is an example that uses ``devshell`` on a target named
20``matchbox-desktop``:: 20``matchbox-desktop``::
21 21
22 $ bitbake matchbox-desktop -c devshell 22 $ bitbake matchbox-desktop -c devshell
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 2da5d9f93e..9bfbd726d9 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -82,7 +82,7 @@ Follow these general steps to create your layer without using tools:
82 LAYERVERSION_yoctobsp = "4" 82 LAYERVERSION_yoctobsp = "4"
83 LAYERSERIES_COMPAT_yoctobsp = "dunfell" 83 LAYERSERIES_COMPAT_yoctobsp = "dunfell"
84 84
85 Following is an explanation of the layer configuration file: 85 Here is an explanation of the layer configuration file:
86 86
87 - :term:`BBPATH`: Adds the layer's 87 - :term:`BBPATH`: Adds the layer's
88 root directory to BitBake's search path. Through the use of the 88 root directory to BitBake's search path. Through the use of the
@@ -191,7 +191,7 @@ following list:
191- *Structure Your Layers:* Proper use of overrides within append files 191- *Structure Your Layers:* Proper use of overrides within append files
192 and placement of machine-specific files within your layer can ensure 192 and placement of machine-specific files within your layer can ensure
193 that a build is not using the wrong Metadata and negatively impacting 193 that a build is not using the wrong Metadata and negatively impacting
194 a build for a different machine. Following are some examples: 194 a build for a different machine. Here are some examples:
195 195
196 - *Modify Variables to Support a Different Machine:* Suppose you 196 - *Modify Variables to Support a Different Machine:* Suppose you
197 have a layer named ``meta-one`` that adds support for building 197 have a layer named ``meta-one`` that adds support for building
@@ -513,7 +513,7 @@ In the main recipe, note the :term:`SRC_URI`
513variable, which tells the OpenEmbedded build system where to find files 513variable, which tells the OpenEmbedded build system where to find files
514during the build. 514during the build.
515 515
516Following is the append file, which is named ``formfactor_0.0.bbappend`` 516Here is the append file, which is named ``formfactor_0.0.bbappend``
517and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The 517and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The
518file is in the layer at ``recipes-bsp/formfactor``:: 518file is in the layer at ``recipes-bsp/formfactor``::
519 519
@@ -588,7 +588,7 @@ Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named
588 fi 588 fi
589 } 589 }
590 590
591Following is the append file, which is named ``xserver-xf86-config_%.bbappend`` 591Here is the append file, which is named ``xserver-xf86-config_%.bbappend``
592and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The 592and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The
593file is in the layer at ``recipes-graphics/xorg-xserver``:: 593file is in the layer at ``recipes-graphics/xorg-xserver``::
594 594
diff --git a/documentation/dev-manual/libraries.rst b/documentation/dev-manual/libraries.rst
index ae4ca27209..521dbb9a7c 100644
--- a/documentation/dev-manual/libraries.rst
+++ b/documentation/dev-manual/libraries.rst
@@ -37,7 +37,7 @@ library files.
37 Some previously released versions of the Yocto Project defined the 37 Some previously released versions of the Yocto Project defined the
38 static library files through ``${PN}-dev``. 38 static library files through ``${PN}-dev``.
39 39
40Following is part of the BitBake configuration file, where you can see 40Here is the part of the BitBake configuration file, where you can see
41how the static library files are defined:: 41how the static library files are defined::
42 42
43 PACKAGE_BEFORE_PN ?= "" 43 PACKAGE_BEFORE_PN ?= ""
@@ -177,7 +177,7 @@ Additional Implementation Details
177--------------------------------- 177---------------------------------
178 178
179There are generic implementation details as well as details that are specific to 179There are generic implementation details as well as details that are specific to
180package management systems. Following are implementation details 180package management systems. Here are implementation details
181that exist regardless of the package management system: 181that exist regardless of the package management system:
182 182
183- The typical convention used for the class extension code as used by 183- The typical convention used for the class extension code as used by
diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
index 419af7c326..197712b68d 100644
--- a/documentation/dev-manual/licenses.rst
+++ b/documentation/dev-manual/licenses.rst
@@ -27,7 +27,7 @@ Specifying the ``LIC_FILES_CHKSUM`` Variable
27-------------------------------------------- 27--------------------------------------------
28 28
29The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text 29The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text
30in the source code for the recipe. Following is an example of how to 30in the source code for the recipe. Here is an example of how to
31specify :term:`LIC_FILES_CHKSUM`:: 31specify :term:`LIC_FILES_CHKSUM`::
32 32
33 LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ 33 LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \
diff --git a/documentation/dev-manual/new-machine.rst b/documentation/dev-manual/new-machine.rst
index b7978f4ba9..d007c1631f 100644
--- a/documentation/dev-manual/new-machine.rst
+++ b/documentation/dev-manual/new-machine.rst
@@ -104,7 +104,7 @@ contains directories for specific machines such as ``qemuarm`` and
104defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file 104defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file
105found in the same area. 105found in the same area.
106 106
107Following is an example for "qemuarm" machine:: 107Here is an example for "qemuarm" machine::
108 108
109 HAVE_TOUCHSCREEN=1 109 HAVE_TOUCHSCREEN=1
110 HAVE_KEYBOARD=1 110 HAVE_KEYBOARD=1
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index ed87f9b2d0..be52610621 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -100,7 +100,7 @@ command::
100 100
101Running ``recipetool create -o OUTFILE`` creates the base recipe and 101Running ``recipetool create -o OUTFILE`` creates the base recipe and
102locates it properly in the layer that contains your source files. 102locates it properly in the layer that contains your source files.
103Following are some syntax examples: 103Here are some syntax examples:
104 104
105 - Use this syntax to generate a recipe based on source. Once generated, 105 - Use this syntax to generate a recipe based on source. Once generated,
106 the recipe resides in the existing source code layer:: 106 the recipe resides in the existing source code layer::
@@ -1233,7 +1233,7 @@ inherit the :ref:`ref-classes-autotools` class, which contains the definitions
1233of all the steps needed to build an Autotool-based application. The result of 1233of all the steps needed to build an Autotool-based application. The result of
1234the build is automatically packaged. And, if the application uses NLS for 1234the build is automatically packaged. And, if the application uses NLS for
1235localization, packages with local information are generated (one package per 1235localization, packages with local information are generated (one package per
1236language). Following is one example: (``hello_2.3.bb``):: 1236language). Here is one example: (``hello_2.3.bb``)::
1237 1237
1238 SUMMARY = "GNU Helloworld application" 1238 SUMMARY = "GNU Helloworld application"
1239 SECTION = "examples" 1239 SECTION = "examples"
@@ -1286,7 +1286,7 @@ Splitting an Application into Multiple Packages
1286You can use the variables :term:`PACKAGES` and :term:`FILES` to split an 1286You can use the variables :term:`PACKAGES` and :term:`FILES` to split an
1287application into multiple packages. 1287application into multiple packages.
1288 1288
1289Following is an example that uses the ``libxpm`` recipe. By default, 1289Here is an example that uses the ``libxpm`` recipe. By default,
1290this recipe generates a single package that contains the library along 1290this recipe generates a single package that contains the library along
1291with a few binaries. You can modify the recipe to split the binaries 1291with a few binaries. You can modify the recipe to split the binaries
1292into separate packages:: 1292into separate packages::
@@ -1511,7 +1511,7 @@ in the BitBake User Manual.
1511 when you make the assignment, but this is not generally needed. 1511 when you make the assignment, but this is not generally needed.
1512 1512
1513- *Quote All Assignments ("value"):* Use double quotes around values in 1513- *Quote All Assignments ("value"):* Use double quotes around values in
1514 all variable assignments (e.g. ``"value"``). Following is an example:: 1514 all variable assignments (e.g. ``"value"``). Here is an example::
1515 1515
1516 VAR1 = "${OTHERVAR}" 1516 VAR1 = "${OTHERVAR}"
1517 VAR2 = "The version is ${PV}" 1517 VAR2 = "The version is ${PV}"
diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst
index 79f21d9f34..0e991e409a 100644
--- a/documentation/dev-manual/packages.rst
+++ b/documentation/dev-manual/packages.rst
@@ -365,7 +365,7 @@ For more examples that show how to use ``do_split_packages``, see the
365directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can 365directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can
366also find examples in ``meta/classes-recipe/kernel.bbclass``. 366also find examples in ``meta/classes-recipe/kernel.bbclass``.
367 367
368Following is a reference that shows ``do_split_packages`` mandatory and 368Here is a reference that shows ``do_split_packages`` mandatory and
369optional arguments:: 369optional arguments::
370 370
371 Mandatory arguments 371 Mandatory arguments
@@ -1123,7 +1123,7 @@ The ``devtool edit-recipe`` command lets you take a look at the recipe::
1123 ... 1123 ...
1124 LICENSE:${PN}-vary = "MIT" 1124 LICENSE:${PN}-vary = "MIT"
1125 1125
1126Here are three key points in the previous example: 1126Three key points in the previous example are:
1127 1127
1128- :term:`SRC_URI` uses the NPM 1128- :term:`SRC_URI` uses the NPM
1129 scheme so that the NPM fetcher is used. 1129 scheme so that the NPM fetcher is used.
diff --git a/documentation/dev-manual/prebuilt-libraries.rst b/documentation/dev-manual/prebuilt-libraries.rst
index b80a844e93..a05f39ca1e 100644
--- a/documentation/dev-manual/prebuilt-libraries.rst
+++ b/documentation/dev-manual/prebuilt-libraries.rst
@@ -148,8 +148,8 @@ recipe. By default, ``libfoo.so`` gets packaged into ``${PN}-dev``, which
148triggers a QA warning that a non-symlink library is in a ``-dev`` package, 148triggers a QA warning that a non-symlink library is in a ``-dev`` package,
149and binaries in the same recipe link to the library in ``${PN}-dev``, 149and binaries in the same recipe link to the library in ``${PN}-dev``,
150which triggers more QA warnings. To solve this problem, you need to package the 150which triggers more QA warnings. To solve this problem, you need to package the
151unversioned library into ``${PN}`` where it belongs. The following are the abridged 151unversioned library into ``${PN}`` where it belongs. The abridged
152default :term:`FILES` variables in ``bitbake.conf``:: 152default :term:`FILES` variables in ``bitbake.conf`` are::
153 153
154 SOLIBS = ".so.*" 154 SOLIBS = ".so.*"
155 SOLIBSDEV = ".so" 155 SOLIBSDEV = ".so"
diff --git a/documentation/dev-manual/python-development-shell.rst b/documentation/dev-manual/python-development-shell.rst
index 2dc6a3f138..81a5c43472 100644
--- a/documentation/dev-manual/python-development-shell.rst
+++ b/documentation/dev-manual/python-development-shell.rst
@@ -35,7 +35,7 @@ system were executing them. Consequently, working this way can be
35helpful when debugging a build or preparing software to be used with the 35helpful when debugging a build or preparing software to be used with the
36OpenEmbedded build system. 36OpenEmbedded build system.
37 37
38Following is an example that uses ``pydevshell`` on a target named 38Here is an example that uses ``pydevshell`` on a target named
39``matchbox-desktop``:: 39``matchbox-desktop``::
40 40
41 $ bitbake matchbox-desktop -c pydevshell 41 $ bitbake matchbox-desktop -c pydevshell
diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 88a63c1808..f998e47934 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -318,7 +318,7 @@ timestamp when it needs to look for an image. Minimally, through the use
318of options, you must provide either a machine name, a virtual machine 318of options, you must provide either a machine name, a virtual machine
319image (``*wic.vmdk``), or a kernel image (``*.bin``). 319image (``*wic.vmdk``), or a kernel image (``*.bin``).
320 320
321Following is the command-line help output for the ``runqemu`` command:: 321Here is the command-line help output for the ``runqemu`` command::
322 322
323 $ runqemu --help 323 $ runqemu --help
324 324
@@ -360,7 +360,7 @@ Following is the command-line help output for the ``runqemu`` command::
360``runqemu`` Command-Line Options 360``runqemu`` Command-Line Options
361================================ 361================================
362 362
363Following is a description of ``runqemu`` options you can provide on the 363Here is a description of ``runqemu`` options you can provide on the
364command line: 364command line:
365 365
366.. note:: 366.. note::
diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst
index 7b9345fb79..bd3f42ac09 100644
--- a/documentation/dev-manual/runtime-testing.rst
+++ b/documentation/dev-manual/runtime-testing.rst
@@ -199,7 +199,7 @@ perform a one-time setup of your controller image by doing the following:
199 "controller" image and you can customize the image recipe as you would 199 "controller" image and you can customize the image recipe as you would
200 any other recipe. 200 any other recipe.
201 201
202 Here are the image recipe requirements: 202 Image recipe requirements are:
203 203
204 - Inherits ``core-image`` so that kernel modules are installed. 204 - Inherits ``core-image`` so that kernel modules are installed.
205 205
@@ -578,7 +578,7 @@ data:
578 When set to "true", the package is not automatically installed into 578 When set to "true", the package is not automatically installed into
579 the DUT. 579 the DUT.
580 580
581Following is an example JSON file that handles test "foo" installing 581Here is an example JSON file that handles test "foo" installing
582package "bar" and test "foobar" installing packages "foo" and "bar". 582package "bar" and test "foobar" installing packages "foo" and "bar".
583Once the test is complete, the packages are removed from the DUT:: 583Once the test is complete, the packages are removed from the DUT::
584 584
diff --git a/documentation/dev-manual/speeding-up-build.rst b/documentation/dev-manual/speeding-up-build.rst
index 31b6f75ab0..6e0d7873ac 100644
--- a/documentation/dev-manual/speeding-up-build.rst
+++ b/documentation/dev-manual/speeding-up-build.rst
@@ -33,7 +33,7 @@ auto-scaling ensures that the build system fundamentally takes advantage
33of potential parallel operations during the build based on the build 33of potential parallel operations during the build based on the build
34machine's capabilities. 34machine's capabilities.
35 35
36Following are additional factors that can affect build speed: 36Additional factors that can affect build speed are:
37 37
38- File system type: The file system type that the build is being 38- File system type: The file system type that the build is being
39 performed on can also influence performance. Using ``ext4`` is 39 performed on can also influence performance. Using ``ext4`` is
@@ -88,7 +88,7 @@ that can help you speed up the build:
88 variable to "1". 88 variable to "1".
89 89
90- Disable static library generation for recipes derived from 90- Disable static library generation for recipes derived from
91 ``autoconf`` or ``libtool``: Following is an example showing how to 91 ``autoconf`` or ``libtool``: Here is an example showing how to
92 disable static libraries and still provide an override to handle 92 disable static libraries and still provide an override to handle
93 exceptions:: 93 exceptions::
94 94
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 794da1e672..9dc9b855b3 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -36,7 +36,7 @@ particular working environment and set of practices.
36 equipment together and set up your development environment's 36 equipment together and set up your development environment's
37 hardware topology. 37 hardware topology.
38 38
39 Here are possible roles: 39 Possible roles are:
40 40
41 - *Application Developer:* This type of developer does application 41 - *Application Developer:* This type of developer does application
42 level work on top of an existing software stack. 42 level work on top of an existing software stack.
@@ -99,7 +99,7 @@ particular working environment and set of practices.
99 99
1005. *Set up the Application Development Machines:* As mentioned earlier, 1005. *Set up the Application Development Machines:* As mentioned earlier,
101 application developers are creating applications on top of existing 101 application developers are creating applications on top of existing
102 software stacks. Following are some best practices for setting up 102 software stacks. Here are some best practices for setting up
103 machines used for application development: 103 machines used for application development:
104 104
105 - Use a pre-built toolchain that contains the software stack 105 - Use a pre-built toolchain that contains the software stack
@@ -118,7 +118,7 @@ particular working environment and set of practices.
118 118
1196. *Set up the Core Development Machines:* As mentioned earlier, core 1196. *Set up the Core Development Machines:* As mentioned earlier, core
120 developers work on the contents of the operating system itself. 120 developers work on the contents of the operating system itself.
121 Following are some best practices for setting up machines used for 121 Here are some best practices for setting up machines used for
122 developing images: 122 developing images:
123 123
124 - Have the :term:`OpenEmbedded Build System` available on 124 - Have the :term:`OpenEmbedded Build System` available on