diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/boilerplate.rst | 2 | ||||
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 2 | ||||
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 2 | ||||
| -rw-r--r-- | documentation/dev-manual/common-tasks.rst | 8 | ||||
| -rw-r--r-- | documentation/profile-manual/usage.rst | 26 | ||||
| -rw-r--r-- | documentation/ref-manual/kickstart.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/migration-3.2.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/resources.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 12 | ||||
| -rw-r--r-- | documentation/test-manual/intro.rst | 10 | ||||
| -rw-r--r-- | documentation/test-manual/test-process.rst | 4 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 12 | ||||
| -rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 8 |
15 files changed, 50 insertions, 50 deletions
diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst index 2ad60eb8b9..baccc9fe40 100644 --- a/documentation/boilerplate.rst +++ b/documentation/boilerplate.rst | |||
| @@ -14,5 +14,5 @@ Commons. | |||
| 14 | To report any inaccuracies or problems with this (or any other Yocto Project) | 14 | To report any inaccuracies or problems with this (or any other Yocto Project) |
| 15 | manual, or to send additions or changes, please send email/patches to the Yocto | 15 | manual, or to send additions or changes, please send email/patches to the Yocto |
| 16 | Project documentation mailing list at ``docs@lists.yoctoproject.org`` or | 16 | Project documentation mailing list at ``docs@lists.yoctoproject.org`` or |
| 17 | log into the freenode ``#yocto`` channel. | 17 | log into the Freenode ``#yocto`` channel. |
| 18 | 18 | ||
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 4ac222c7e5..f68ad168b8 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
| @@ -204,7 +204,7 @@ an entire Linux distribution, including the toolchain, from source. | |||
| 204 | meta-toolchain | 204 | meta-toolchain |
| 205 | meta-ide-support | 205 | meta-ide-support |
| 206 | 206 | ||
| 207 | You can also run generated qemu images with a command like 'runqemu qemux86-64' | 207 | You can also run generated QEMU images with a command like 'runqemu qemux86-64' |
| 208 | 208 | ||
| 209 | Among other things, the script creates the :term:`Build Directory`, which is | 209 | Among other things, the script creates the :term:`Build Directory`, which is |
| 210 | ``build`` in this case and is located in the :term:`Source Directory`. After | 210 | ``build`` in this case and is located in the :term:`Source Directory`. After |
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 93e9182490..c24ab28ea2 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
| @@ -289,7 +289,7 @@ individual BSPs could differ. :: | |||
| 289 | meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend | 289 | meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend |
| 290 | 290 | ||
| 291 | Below is an example of the Raspberry Pi BSP layer that is available from | 291 | Below is an example of the Raspberry Pi BSP layer that is available from |
| 292 | the :yocto_git:`Source Respositories <>`: | 292 | the :yocto_git:`Source Repositories <>`: |
| 293 | 293 | ||
| 294 | .. code-block:: none | 294 | .. code-block:: none |
| 295 | 295 | ||
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 4313d905ca..faa5efeb52 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
| @@ -5362,7 +5362,7 @@ command to return the available Wic images as follows: | |||
| 5362 | genericx86 Create an EFI disk image for genericx86* | 5362 | genericx86 Create an EFI disk image for genericx86* |
| 5363 | beaglebone-yocto Create SD card image for Beaglebone | 5363 | beaglebone-yocto Create SD card image for Beaglebone |
| 5364 | edgerouter Create SD card image for Edgerouter | 5364 | edgerouter Create SD card image for Edgerouter |
| 5365 | qemux86-directdisk Create a qemu machine 'pcbios' direct disk image | 5365 | qemux86-directdisk Create a QEMU machine 'pcbios' direct disk image |
| 5366 | directdisk-gpt Create a 'pcbios' direct disk image | 5366 | directdisk-gpt Create a 'pcbios' direct disk image |
| 5367 | mkefidisk Create an EFI disk image | 5367 | mkefidisk Create an EFI disk image |
| 5368 | directdisk Create a 'pcbios' direct disk image | 5368 | directdisk Create a 'pcbios' direct disk image |
| @@ -5509,7 +5509,7 @@ Use the following command to list the available kickstart files: | |||
| 5509 | genericx86 Create an EFI disk image for genericx86* | 5509 | genericx86 Create an EFI disk image for genericx86* |
| 5510 | beaglebone-yocto Create SD card image for Beaglebone | 5510 | beaglebone-yocto Create SD card image for Beaglebone |
| 5511 | edgerouter Create SD card image for Edgerouter | 5511 | edgerouter Create SD card image for Edgerouter |
| 5512 | qemux86-directdisk Create a qemu machine 'pcbios' direct disk image | 5512 | qemux86-directdisk Create a QEMU machine 'pcbios' direct disk image |
| 5513 | directdisk-gpt Create a 'pcbios' direct disk image | 5513 | directdisk-gpt Create a 'pcbios' direct disk image |
| 5514 | mkefidisk Create an EFI disk image | 5514 | mkefidisk Create an EFI disk image |
| 5515 | directdisk Create a 'pcbios' direct disk image | 5515 | directdisk Create a 'pcbios' direct disk image |
| @@ -8522,7 +8522,7 @@ In order to run tests, you need to do the following: | |||
| 8522 | 8522 | ||
| 8523 | - Ubuntu and Debian: ``sysstat`` and ``iproute2`` | 8523 | - Ubuntu and Debian: ``sysstat`` and ``iproute2`` |
| 8524 | 8524 | ||
| 8525 | - OpenSUSE: ``sysstat`` and ``iproute2`` | 8525 | - openSUSE: ``sysstat`` and ``iproute2`` |
| 8526 | 8526 | ||
| 8527 | - Fedora: ``sysstat`` and ``iproute`` | 8527 | - Fedora: ``sysstat`` and ``iproute`` |
| 8528 | 8528 | ||
| @@ -8648,7 +8648,7 @@ perform a one-time setup of your master image by doing the following: | |||
| 8648 | 8648 | ||
| 8649 | - Inherits ``core-image`` so that kernel modules are installed. | 8649 | - Inherits ``core-image`` so that kernel modules are installed. |
| 8650 | 8650 | ||
| 8651 | - Installs normal linux utilities not busybox ones (e.g. ``bash``, | 8651 | - Installs normal linux utilities not BusyBox ones (e.g. ``bash``, |
| 8652 | ``coreutils``, ``tar``, ``gzip``, and ``kmod``). | 8652 | ``coreutils``, ``tar``, ``gzip``, and ``kmod``). |
| 8653 | 8653 | ||
| 8654 | - Uses a custom Initial RAM Disk (initramfs) image with a custom | 8654 | - Uses a custom Initial RAM Disk (initramfs) image with a custom |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index b401cf9040..fd6da6fc41 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
| @@ -100,8 +100,8 @@ Using perf to do Basic Profiling | |||
| 100 | As a simple test case, we'll profile the 'wget' of a fairly large file, | 100 | As a simple test case, we'll profile the 'wget' of a fairly large file, |
| 101 | which is a minimally interesting case because it has both file and | 101 | which is a minimally interesting case because it has both file and |
| 102 | network I/O aspects, and at least in the case of standard Yocto images, | 102 | network I/O aspects, and at least in the case of standard Yocto images, |
| 103 | it's implemented as part of busybox, so the methods we use to analyze it | 103 | it's implemented as part of BusyBox, so the methods we use to analyze it |
| 104 | can be used in a very similar way to the whole host of supported busybox | 104 | can be used in a very similar way to the whole host of supported BusyBox |
| 105 | applets in Yocto. :: | 105 | applets in Yocto. :: |
| 106 | 106 | ||
| 107 | root@crownbay:~# rm linux-2.6.19.2.tar.bz2; \ | 107 | root@crownbay:~# rm linux-2.6.19.2.tar.bz2; \ |
| @@ -251,7 +251,7 @@ As a bit of background explanation for these callchains, think about | |||
| 251 | what happens at a high level when you run wget to get a file out on the | 251 | what happens at a high level when you run wget to get a file out on the |
| 252 | network. Basically what happens is that the data comes into the kernel | 252 | network. Basically what happens is that the data comes into the kernel |
| 253 | via the network connection (socket) and is passed to the userspace | 253 | via the network connection (socket) and is passed to the userspace |
| 254 | program 'wget' (which is actually a part of busybox, but that's not | 254 | program 'wget' (which is actually a part of BusyBox, but that's not |
| 255 | important for now), which takes the buffers the kernel passes to it and | 255 | important for now), which takes the buffers the kernel passes to it and |
| 256 | writes it to a disk file to save it. | 256 | writes it to a disk file to save it. |
| 257 | 257 | ||
| @@ -277,16 +277,16 @@ Now that we've seen the basic layout of the profile data and the basics | |||
| 277 | of how to extract useful information out of it, let's get back to the | 277 | of how to extract useful information out of it, let's get back to the |
| 278 | task at hand and see if we can get some basic idea about where the time | 278 | task at hand and see if we can get some basic idea about where the time |
| 279 | is spent in the program we're profiling, wget. Remember that wget is | 279 | is spent in the program we're profiling, wget. Remember that wget is |
| 280 | actually implemented as an applet in busybox, so while the process name | 280 | actually implemented as an applet in BusyBox, so while the process name |
| 281 | is 'wget', the executable we're actually interested in is busybox. So | 281 | is 'wget', the executable we're actually interested in is BusyBox. So |
| 282 | let's expand the first entry containing busybox: | 282 | let's expand the first entry containing BusyBox: |
| 283 | 283 | ||
| 284 | .. image:: figures/perf-wget-busybox-expanded-stripped.png | 284 | .. image:: figures/perf-wget-busybox-expanded-stripped.png |
| 285 | :align: center | 285 | :align: center |
| 286 | 286 | ||
| 287 | Again, before we expanded we saw that the function was labeled with a | 287 | Again, before we expanded we saw that the function was labeled with a |
| 288 | hex value instead of a symbol as with most of the kernel entries. | 288 | hex value instead of a symbol as with most of the kernel entries. |
| 289 | Expanding the busybox entry doesn't make it any better. | 289 | Expanding the BusyBox entry doesn't make it any better. |
| 290 | 290 | ||
| 291 | The problem is that perf can't find the symbol information for the | 291 | The problem is that perf can't find the symbol information for the |
| 292 | busybox binary, which is actually stripped out by the Yocto build | 292 | busybox binary, which is actually stripped out by the Yocto build |
| @@ -299,7 +299,7 @@ when you build the image: :: | |||
| 299 | 299 | ||
| 300 | However, we already have an image with the binaries stripped, so | 300 | However, we already have an image with the binaries stripped, so |
| 301 | what can we do to get perf to resolve the symbols? Basically we need to | 301 | what can we do to get perf to resolve the symbols? Basically we need to |
| 302 | install the debuginfo for the busybox package. | 302 | install the debuginfo for the BusyBox package. |
| 303 | 303 | ||
| 304 | To generate the debug info for the packages in the image, we can add | 304 | To generate the debug info for the packages in the image, we can add |
| 305 | ``dbg-pkgs`` to :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example: :: | 305 | ``dbg-pkgs`` to :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example: :: |
| @@ -314,7 +314,7 @@ in the ``local.conf`` file: :: | |||
| 314 | PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' | 314 | PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' |
| 315 | 315 | ||
| 316 | Once we've done that, we can install the | 316 | Once we've done that, we can install the |
| 317 | debuginfo for busybox. The debug packages once built can be found in | 317 | debuginfo for BusyBox. The debug packages once built can be found in |
| 318 | ``build/tmp/deploy/rpm/*`` on the host system. Find the busybox-dbg-...rpm | 318 | ``build/tmp/deploy/rpm/*`` on the host system. Find the busybox-dbg-...rpm |
| 319 | file and copy it to the target. For example: :: | 319 | file and copy it to the target. For example: :: |
| 320 | 320 | ||
| @@ -325,7 +325,7 @@ Now install the debug rpm on the target: :: | |||
| 325 | 325 | ||
| 326 | root@crownbay:~# rpm -i busybox-dbg-1.20.2-r2.core2_32.rpm | 326 | root@crownbay:~# rpm -i busybox-dbg-1.20.2-r2.core2_32.rpm |
| 327 | 327 | ||
| 328 | Now that the debuginfo is installed, we see that the busybox entries now display | 328 | Now that the debuginfo is installed, we see that the BusyBox entries now display |
| 329 | their functions symbolically: | 329 | their functions symbolically: |
| 330 | 330 | ||
| 331 | .. image:: figures/perf-wget-busybox-debuginfo.png | 331 | .. image:: figures/perf-wget-busybox-debuginfo.png |
| @@ -345,11 +345,11 @@ expanded all the nodes using the 'E' key): | |||
| 345 | .. image:: figures/perf-wget-busybox-dso-zoom.png | 345 | .. image:: figures/perf-wget-busybox-dso-zoom.png |
| 346 | :align: center | 346 | :align: center |
| 347 | 347 | ||
| 348 | Finally, we can see that now that the busybox debuginfo is installed, | 348 | Finally, we can see that now that the BusyBox debuginfo is installed, |
| 349 | the previously unresolved symbol in the ``sys_clock_gettime()`` entry | 349 | the previously unresolved symbol in the ``sys_clock_gettime()`` entry |
| 350 | mentioned previously is now resolved, and shows that the | 350 | mentioned previously is now resolved, and shows that the |
| 351 | sys_clock_gettime system call that was the source of 6.75% of the | 351 | sys_clock_gettime system call that was the source of 6.75% of the |
| 352 | copy-to-user overhead was initiated by the ``handle_input()`` busybox | 352 | copy-to-user overhead was initiated by the ``handle_input()`` BusyBox |
| 353 | function: | 353 | function: |
| 354 | 354 | ||
| 355 | .. image:: figures/perf-wget-g-copy-to-user-expanded-debuginfo.png | 355 | .. image:: figures/perf-wget-g-copy-to-user-expanded-debuginfo.png |
| @@ -1900,7 +1900,7 @@ the target: :: | |||
| 1900 | meta-toolchain | 1900 | meta-toolchain |
| 1901 | meta-ide-support | 1901 | meta-ide-support |
| 1902 | 1902 | ||
| 1903 | You can also run generated qemu images with a command like 'runqemu qemux86-64' | 1903 | You can also run generated QEMU images with a command like 'runqemu qemux86-64' |
| 1904 | 1904 | ||
| 1905 | Once you've done that, you can cd to whatever | 1905 | Once you've done that, you can cd to whatever |
| 1906 | directory contains your scripts and use 'crosstap' to run the script: :: | 1906 | directory contains your scripts and use 'crosstap' to run the script: :: |
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 472820f165..b87cdc13b1 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst | |||
| @@ -33,7 +33,7 @@ Either of these commands creates a partition on the system and uses the | |||
| 33 | following syntax: | 33 | following syntax: |
| 34 | :: | 34 | :: |
| 35 | 35 | ||
| 36 | part [mntpoint] | 36 | part [mntpoint] |
| 37 | partition [mntpoint] | 37 | partition [mntpoint] |
| 38 | 38 | ||
| 39 | If you do not | 39 | If you do not |
| @@ -55,7 +55,7 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or | |||
| 55 | .. note:: | 55 | .. note:: |
| 56 | 56 | ||
| 57 | The mount program must understand the PARTUUID syntax you use with | 57 | The mount program must understand the PARTUUID syntax you use with |
| 58 | ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox | 58 | ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox |
| 59 | versions of these application are currently excluded. | 59 | versions of these application are currently excluded. |
| 60 | 60 | ||
| 61 | Here is an example that uses "/" as the mountpoint. The command uses | 61 | Here is an example that uses "/" as the mountpoint. The command uses |
diff --git a/documentation/ref-manual/migration-3.2.rst b/documentation/ref-manual/migration-3.2.rst index 65a9ff4cac..cca8124f22 100644 --- a/documentation/ref-manual/migration-3.2.rst +++ b/documentation/ref-manual/migration-3.2.rst | |||
| @@ -308,6 +308,6 @@ Miscellaneous changes | |||
| 308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. | 308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. |
| 309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. | 309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. |
| 310 | - ``oe.utils.is_machine_specific()`` and ``oe.utils.machine_paths()`` have been removed as their utility was questionable. In the unlikely event that you have references to these in your own code, then the code will need to be reworked. | 310 | - ``oe.utils.is_machine_specific()`` and ``oe.utils.machine_paths()`` have been removed as their utility was questionable. In the unlikely event that you have references to these in your own code, then the code will need to be reworked. |
| 311 | - The ``i2ctransfer`` module is now disabled by default when building ``busybox`` in order to be consistent with disabling the other i2c tools there. If you do wish the i2ctransfer module to be built in busybox then add ``CONFIG_I2CTRANSFER=y`` to your custom busybox configuration. | 311 | - The ``i2ctransfer`` module is now disabled by default when building ``busybox`` in order to be consistent with disabling the other i2c tools there. If you do wish the i2ctransfer module to be built in BusyBox then add ``CONFIG_I2CTRANSFER=y`` to your custom BusyBox configuration. |
| 312 | - In the ``Upstream-Status`` header convention for patches, ``Accepted`` has been replaced with ``Backport`` as these almost always mean the same thing i.e. the patch is already upstream and may need to be removed in a future recipe upgrade. If you are adding these headers to your own patches then use ``Backport`` to indicate that the patch has been sent upstream. | 312 | - In the ``Upstream-Status`` header convention for patches, ``Accepted`` has been replaced with ``Backport`` as these almost always mean the same thing i.e. the patch is already upstream and may need to be removed in a future recipe upgrade. If you are adding these headers to your own patches then use ``Backport`` to indicate that the patch has been sent upstream. |
| 313 | - The ``tune-supersparc.inc`` tune file has been removed as it does not appear to be widely used and no longer works. | 313 | - The ``tune-supersparc.inc`` tune file has been removed as it does not appear to be widely used and no longer works. |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 7554164d11..663f0d96d5 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
| @@ -91,7 +91,7 @@ For more Yocto Project-related mailing lists, see the | |||
| 91 | Internet Relay Chat (IRC) | 91 | Internet Relay Chat (IRC) |
| 92 | ========================= | 92 | ========================= |
| 93 | 93 | ||
| 94 | Two IRC channels on freenode are available for the Yocto Project and | 94 | Two IRC channels on Freenode are available for the Yocto Project and |
| 95 | Poky discussions: | 95 | Poky discussions: |
| 96 | 96 | ||
| 97 | - ``#yocto`` | 97 | - ``#yocto`` |
| @@ -189,7 +189,7 @@ Here is a list of resources you might find helpful: | |||
| 189 | implementation of Bugzilla for logging and tracking Yocto Project | 189 | implementation of Bugzilla for logging and tracking Yocto Project |
| 190 | defects. | 190 | defects. |
| 191 | 191 | ||
| 192 | - *Internet Relay Chat (IRC):* Two IRC channels on freenode are | 192 | - *Internet Relay Chat (IRC):* Two IRC channels on Freenode are |
| 193 | available for Yocto Project and Poky discussions: ``#yocto`` and | 193 | available for Yocto Project and Poky discussions: ``#yocto`` and |
| 194 | ``#poky``, respectively. | 194 | ``#poky``, respectively. |
| 195 | 195 | ||
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index ad3f4ab44a..0f2093a8d4 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -168,7 +168,7 @@ possible targets to build. Here is an example: | |||
| 168 | meta-toolchain | 168 | meta-toolchain |
| 169 | meta-ide-support | 169 | meta-ide-support |
| 170 | 170 | ||
| 171 | You can also run generated qemu images with a command like 'runqemu qemux86-64' | 171 | You can also run generated QEMU images with a command like 'runqemu qemux86-64' |
| 172 | 172 | ||
| 173 | The default output of the ``oe-init-build-env`` script is from the | 173 | The default output of the ``oe-init-build-env`` script is from the |
| 174 | ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory | 174 | ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index c8c1381cb9..9f423e7bb5 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
| @@ -59,7 +59,7 @@ distributions: | |||
| 59 | 59 | ||
| 60 | - Debian GNU/Linux 10.x (Buster) | 60 | - Debian GNU/Linux 10.x (Buster) |
| 61 | 61 | ||
| 62 | - OpenSUSE Leap 15.1 | 62 | - openSUSE Leap 15.1 |
| 63 | 63 | ||
| 64 | 64 | ||
| 65 | .. note:: | 65 | .. note:: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0310429bdc..f551c4d376 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -2582,7 +2582,7 @@ system and gives an overview of their function and contents. | |||
| 2582 | and new for generating new keys. | 2582 | and new for generating new keys. |
| 2583 | 2583 | ||
| 2584 | :term:`FIT_KEY_SIGN_PKCS` | 2584 | :term:`FIT_KEY_SIGN_PKCS` |
| 2585 | Format for public key ceritifcate used in signing fitImage. | 2585 | Format for public key certificate used in signing fitImage. |
| 2586 | The default value is "x509". | 2586 | The default value is "x509". |
| 2587 | 2587 | ||
| 2588 | :term:`FIT_SIGN_ALG` | 2588 | :term:`FIT_SIGN_ALG` |
| @@ -3449,7 +3449,7 @@ system and gives an overview of their function and contents. | |||
| 3449 | 3449 | ||
| 3450 | It is possible to define a list of licenses that are allowed to be | 3450 | It is possible to define a list of licenses that are allowed to be |
| 3451 | used instead of the licenses that are excluded. To do this, define | 3451 | used instead of the licenses that are excluded. To do this, define |
| 3452 | a variable ``COMPATIBLE_LICENSES`` with the names of the licences | 3452 | a variable ``COMPATIBLE_LICENSES`` with the names of the licenses |
| 3453 | that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: | 3453 | that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: |
| 3454 | :: | 3454 | :: |
| 3455 | 3455 | ||
| @@ -3457,8 +3457,8 @@ system and gives an overview of their function and contents. | |||
| 3457 | 3457 | ||
| 3458 | 3458 | ||
| 3459 | This will result in ``INCOMPATIBLE_LICENSE`` containing the names of | 3459 | This will result in ``INCOMPATIBLE_LICENSE`` containing the names of |
| 3460 | all licences from :term:`AVAILABLE_LICENSES` except the ones specified | 3460 | all licenses from :term:`AVAILABLE_LICENSES` except the ones specified |
| 3461 | in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to | 3461 | in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licenses to |
| 3462 | be used. | 3462 | be used. |
| 3463 | 3463 | ||
| 3464 | :term:`INHERIT` | 3464 | :term:`INHERIT` |
| @@ -5011,7 +5011,7 @@ system and gives an overview of their function and contents. | |||
| 5011 | ${PN}-${PV} | 5011 | ${PN}-${PV} |
| 5012 | 5012 | ||
| 5013 | :term:`PACKAGE_ADD_METADATA` | 5013 | :term:`PACKAGE_ADD_METADATA` |
| 5014 | This variable defines additional metdata to add to packages. | 5014 | This variable defines additional metadata to add to packages. |
| 5015 | 5015 | ||
| 5016 | You may find you need to inject additional metadata into packages. | 5016 | You may find you need to inject additional metadata into packages. |
| 5017 | This variable allows you to do that by setting the injected data as | 5017 | This variable allows you to do that by setting the injected data as |
| @@ -7092,7 +7092,7 @@ system and gives an overview of their function and contents. | |||
| 7092 | - ``git://`` - Fetches files from a Git revision control | 7092 | - ``git://`` - Fetches files from a Git revision control |
| 7093 | repository. | 7093 | repository. |
| 7094 | 7094 | ||
| 7095 | - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service) | 7095 | - ``osc://`` - Fetches files from an OSC (openSUSE Build service) |
| 7096 | revision control repository. | 7096 | revision control repository. |
| 7097 | 7097 | ||
| 7098 | - ``repo://`` - Fetches files from a repo (Git) repository. | 7098 | - ``repo://`` - Fetches files from a repo (Git) repository. |
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 81c24a8c3f..101d283665 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
| @@ -26,7 +26,7 @@ engineers: | |||
| 26 | 26 | ||
| 27 | - *yocto-autobuilder2:* This | 27 | - *yocto-autobuilder2:* This |
| 28 | :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` | 28 | :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` |
| 29 | is the main README which detials how to set up the Yocto Project | 29 | is the main README which details how to set up the Yocto Project |
| 30 | Autobuilder. The ``yocto-autobuilder2`` repository represents the | 30 | Autobuilder. The ``yocto-autobuilder2`` repository represents the |
| 31 | Yocto Project's console UI plugin to Buildbot and the configuration | 31 | Yocto Project's console UI plugin to Buildbot and the configuration |
| 32 | necessary to configure Buildbot to perform the testing the project | 32 | necessary to configure Buildbot to perform the testing the project |
| @@ -88,7 +88,7 @@ Yocto Project Tests - Types of Testing Overview | |||
| 88 | =============================================== | 88 | =============================================== |
| 89 | 89 | ||
| 90 | The Autobuilder tests different elements of the project by using | 90 | The Autobuilder tests different elements of the project by using |
| 91 | thefollowing types of tests: | 91 | the following types of tests: |
| 92 | 92 | ||
| 93 | - *Build Testing:* Tests whether specific configurations build by | 93 | - *Build Testing:* Tests whether specific configurations build by |
| 94 | varying :term:`MACHINE`, | 94 | varying :term:`MACHINE`, |
| @@ -124,7 +124,7 @@ thefollowing types of tests: | |||
| 124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. | 124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. |
| 125 | 125 | ||
| 126 | - *Feature Testing:* Various scenario-based tests are run through the | 126 | - *Feature Testing:* Various scenario-based tests are run through the |
| 127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distrubutions | 127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distributions |
| 128 | we support. | 128 | we support. |
| 129 | 129 | ||
| 130 | - *Image Testing:* Image tests initiated through the following command:: | 130 | - *Image Testing:* Image tests initiated through the following command:: |
| @@ -474,7 +474,7 @@ correctly. The test would only run if python3 is installed in the SDK. | |||
| 474 | ---------------------- | 474 | ---------------------- |
| 475 | 475 | ||
| 476 | The performance tests usually measure how long operations take and the | 476 | The performance tests usually measure how long operations take and the |
| 477 | resource utilisation as that happens. An example from | 477 | resource utilization as that happens. An example from |
| 478 | ``meta/lib/oeqa/buildperf/test_basic.py`` contains the following:: | 478 | ``meta/lib/oeqa/buildperf/test_basic.py`` contains the following:: |
| 479 | 479 | ||
| 480 | class Test3(BuildPerfTestCase): | 480 | class Test3(BuildPerfTestCase): |
| @@ -524,5 +524,5 @@ This is particularly true for oe-selftests since these can run in | |||
| 524 | parallel and changing metadata leads to changing checksums, which | 524 | parallel and changing metadata leads to changing checksums, which |
| 525 | confuses BitBake while running in parallel. If this is necessary, copy | 525 | confuses BitBake while running in parallel. If this is necessary, copy |
| 526 | layers to a temporary location and modify them. Some tests need to | 526 | layers to a temporary location and modify them. Some tests need to |
| 527 | change metadata, such as the devtool tests. To prevent the metadate from | 527 | change metadata, such as the devtool tests. To protect the metadata from |
| 528 | changes, set up temporary copies of that data first. | 528 | changes, set up temporary copies of that data first. |
diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 8a5e29d922..508ead5fad 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst | |||
| @@ -59,13 +59,13 @@ Release Builds | |||
| 59 | 59 | ||
| 60 | The project typically has two major releases a year with a six month | 60 | The project typically has two major releases a year with a six month |
| 61 | cadence in April and October. Between these there would be a number of | 61 | cadence in April and October. Between these there would be a number of |
| 62 | milestone releases (usually four) with the final one being stablization | 62 | milestone releases (usually four) with the final one being stabilization |
| 63 | only along with point releases of our stable branches. | 63 | only along with point releases of our stable branches. |
| 64 | 64 | ||
| 65 | The build and release process for these project releases is similar to | 65 | The build and release process for these project releases is similar to |
| 66 | that in `Day to Day Development <#test-daily-devel>`__, in that the | 66 | that in `Day to Day Development <#test-daily-devel>`__, in that the |
| 67 | a-full target of the Autobuilder is used but in addition the form is | 67 | a-full target of the Autobuilder is used but in addition the form is |
| 68 | configured to generate and publish artefacts and the milestone number, | 68 | configured to generate and publish artifacts and the milestone number, |
| 69 | version, release candidate number and other information is entered. The | 69 | version, release candidate number and other information is entered. The |
| 70 | box to "generate an email to QA"is also checked. | 70 | box to "generate an email to QA"is also checked. |
| 71 | 71 | ||
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index 199cc97a85..2d9d6735a9 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
| @@ -9,14 +9,14 @@ Execution Flow within the Autobuilder | |||
| 9 | 9 | ||
| 10 | The "a-full" and "a-quick" targets are the usual entry points into the | 10 | The "a-full" and "a-quick" targets are the usual entry points into the |
| 11 | Autobuilder and it makes sense to follow the process through the system | 11 | Autobuilder and it makes sense to follow the process through the system |
| 12 | starting there. This is best visualised from the Autobuilder Console | 12 | starting there. This is best visualized from the Autobuilder Console |
| 13 | view (:yocto_ab:`/typhoon/#/console`). | 13 | view (:yocto_ab:`/typhoon/#/console`). |
| 14 | 14 | ||
| 15 | Each item along the top of that view represents some "target build" and | 15 | Each item along the top of that view represents some "target build" and |
| 16 | these targets are all run in parallel. The 'full' build will trigger the | 16 | these targets are all run in parallel. The 'full' build will trigger the |
| 17 | majority of them, the "quick" build will trigger some subset of them. | 17 | majority of them, the "quick" build will trigger some subset of them. |
| 18 | The Autobuilder effectively runs whichever configuration is defined for | 18 | The Autobuilder effectively runs whichever configuration is defined for |
| 19 | each of those targets on a seperate buildbot worker. To understand the | 19 | each of those targets on a separate buildbot worker. To understand the |
| 20 | configuration, you need to look at the entry on ``config.json`` file | 20 | configuration, you need to look at the entry on ``config.json`` file |
| 21 | within the ``yocto-autobuilder-helper`` repository. The targets are | 21 | within the ``yocto-autobuilder-helper`` repository. The targets are |
| 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 | 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 |
| @@ -64,10 +64,10 @@ While not every detail of this is covered here, you can see how the | |||
| 64 | template mechanism allows quite complex configurations to be built up | 64 | template mechanism allows quite complex configurations to be built up |
| 65 | yet allows duplication and repetition to be kept to a minimum. | 65 | yet allows duplication and repetition to be kept to a minimum. |
| 66 | 66 | ||
| 67 | The different build targets are designed to allow for parallelisation, | 67 | The different build targets are designed to allow for parallelization, |
| 68 | so different machines are usually built in parallel, operations using | 68 | so different machines are usually built in parallel, operations using |
| 69 | the same machine and metadata are built sequentially, with the aim of | 69 | the same machine and metadata are built sequentially, with the aim of |
| 70 | trying to optimise build efficiency as much as possible. | 70 | trying to optimize build efficiency as much as possible. |
| 71 | 71 | ||
| 72 | The ``config.json`` file is processed by the scripts in the Helper | 72 | The ``config.json`` file is processed by the scripts in the Helper |
| 73 | repository in the ``scripts`` directory. The following section details | 73 | repository in the ``scripts`` directory. The following section details |
| @@ -164,7 +164,7 @@ Autobuilder Worker Janitor | |||
| 164 | 164 | ||
| 165 | This is a process running on each Worker that performs two basic | 165 | This is a process running on each Worker that performs two basic |
| 166 | operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and | 166 | operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and |
| 167 | maintainenance of a cache of cloned repositories to improve the speed | 167 | maintenance of a cache of cloned repositories to improve the speed |
| 168 | the system can checkout repositories. | 168 | the system can checkout repositories. |
| 169 | 169 | ||
| 170 | Shared DL_DIR | 170 | Shared DL_DIR |
| @@ -250,7 +250,7 @@ Deploying Yocto Autobuilder | |||
| 250 | =========================== | 250 | =========================== |
| 251 | 251 | ||
| 252 | The most up to date information about how to setup and deploy your own | 252 | The most up to date information about how to setup and deploy your own |
| 253 | Autbuilder can be found in README.md in the ``yocto-autobuilder2`` | 253 | Autobuilder can be found in README.md in the ``yocto-autobuilder2`` |
| 254 | repository. | 254 | repository. |
| 255 | 255 | ||
| 256 | We hope that people can use the ``yocto-autobuilder2`` code directly but | 256 | We hope that people can use the ``yocto-autobuilder2`` code directly but |
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index cabf0250c4..8f0ec94496 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst | |||
| @@ -362,7 +362,7 @@ Perform the following steps to install Toaster: | |||
| 362 | 362 | ||
| 363 | /etc/httpd/conf.d/toaster.conf | 363 | /etc/httpd/conf.d/toaster.conf |
| 364 | 364 | ||
| 365 | If you are using OpenSUSE, put it here:: | 365 | If you are using openSUSE, put it here:: |
| 366 | 366 | ||
| 367 | /etc/apache2/conf.d/toaster.conf | 367 | /etc/apache2/conf.d/toaster.conf |
| 368 | 368 | ||
| @@ -380,13 +380,13 @@ Perform the following steps to install Toaster: | |||
| 380 | Require all granted | 380 | Require all granted |
| 381 | </IfModule> | 381 | </IfModule> |
| 382 | </Directory> | 382 | </Directory> |
| 383 | 383 | ||
| 384 | <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain> | 384 | <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain> |
| 385 | <Files "wsgi.py"> | 385 | <Files "wsgi.py"> |
| 386 | Require all granted | 386 | Require all granted |
| 387 | </Files> | 387 | </Files> |
| 388 | </Directory> | 388 | </Directory> |
| 389 | 389 | ||
| 390 | WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages | 390 | WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages |
| 391 | WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py" | 391 | WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py" |
| 392 | <Location /> | 392 | <Location /> |
| @@ -402,7 +402,7 @@ Perform the following steps to install Toaster: | |||
| 402 | $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py | 402 | $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py |
| 403 | 403 | ||
| 404 | Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu, | 404 | Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu, |
| 405 | Debian, and OpenSUSE use:: | 405 | Debian, and openSUSE use:: |
| 406 | 406 | ||
| 407 | $ sudo service apache2 restart | 407 | $ sudo service apache2 restart |
| 408 | 408 | ||
