summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-03-29 15:17:52 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-06 22:29:49 +0100
commit44d0532c8930d4c9bcdefebb15837acf1fd839d4 (patch)
tree0b355b250994a53aa57c0327c5e9b1da9b0ba277 /documentation/ref-manual
parent5480a85f016474371fe249b58e48b4de1971296b (diff)
downloadpoky-44d0532c8930d4c9bcdefebb15837acf1fd839d4.tar.gz
manuals: Fix typos and spacing
Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/TODO6
-rw-r--r--documentation/ref-manual/classes.rst2
-rw-r--r--documentation/ref-manual/faq.rst2
-rw-r--r--documentation/ref-manual/migration-1.7.rst2
-rw-r--r--documentation/ref-manual/release-process.rst2
-rw-r--r--documentation/ref-manual/system-requirements.rst2
-rw-r--r--documentation/ref-manual/variables.rst4
7 files changed, 10 insertions, 10 deletions
diff --git a/documentation/ref-manual/TODO b/documentation/ref-manual/TODO
index ee0db977cc..0510f54710 100644
--- a/documentation/ref-manual/TODO
+++ b/documentation/ref-manual/TODO
@@ -1,10 +1,10 @@
1Handbook Todo List: 1Handbook Todo List:
2 2
3 * Document adding a new IMAGE_FEATURE to the customising images section 3 * Document adding a new IMAGE_FEATURE to the customising images section
4 * Add instructions about using zaurus/openmoko emulation 4 * Add instructions about using zaurus/openmoko emulation
5 * Add component overview/block diagrams 5 * Add component overview/block diagrams
6 * Software Deevelopment intro should mention its software development for 6 * Software Development intro should mention its software development for
7 intended target and could be a different arch etc and thus special case. 7 intended target and could be a different arch etc and thus special case.
8 * Expand insane.bbclass documentation to cover tests 8 * Expand insane.bbclass documentation to cover tests
9 * Document remaining classes (see list in ref-classes) 9 * Document remaining classes (see list in ref-classes)
10 * Document formfactor 10 * Document formfactor
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index be112e0faf..6d9779f6e7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1426,7 +1426,7 @@ Only a single U-boot boot script can be added to the FIT image created by
1426The boot script is specified in the ITS file as a text file containing 1426The boot script is specified in the ITS file as a text file containing
1427U-boot commands. When using a boot script the user should configure the 1427U-boot commands. When using a boot script the user should configure the
1428U-boot ``do_install`` task to copy the script to sysroot. 1428U-boot ``do_install`` task to copy the script to sysroot.
1429So the script can be included in the the FIT image by the ``kernel-fitimage`` 1429So the script can be included in the FIT image by the ``kernel-fitimage``
1430class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to 1430class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
1431load the boot script from the FIT image and executes it. 1431load the boot script from the FIT image and executes it.
1432 1432
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 34b26ee3ef..3b65588caa 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -449,7 +449,7 @@ variable ``bindir``. The makefile's hardcoded default value of
449"/usr/bin" worked most of the time, but not for the recipe's ``-native`` 449"/usr/bin" worked most of the time, but not for the recipe's ``-native``
450variant. For another example, permissions errors might be caused by a 450variant. For another example, permissions errors might be caused by a
451Makefile that ignores ``DESTDIR`` or uses a different name for that 451Makefile that ignores ``DESTDIR`` or uses a different name for that
452environment variable. Check the the build system to see if these kinds 452environment variable. Check the build system to see if these kinds
453of issues exist. 453of issues exist.
454 454
455**Q:** I'm adding a binary in a recipe but it's different in the image, what is 455**Q:** I'm adding a binary in a recipe but it's different in the image, what is
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst
index 54544e4798..c00768ca7b 100644
--- a/documentation/ref-manual/migration-1.7.rst
+++ b/documentation/ref-manual/migration-1.7.rst
@@ -12,7 +12,7 @@ Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf``
12The QEMU recipe now uses a number of 12The QEMU recipe now uses a number of
13:term:`PACKAGECONFIG` options to enable various 13:term:`PACKAGECONFIG` options to enable various
14optional features. The method used to set defaults for these options 14optional features. The method used to set defaults for these options
15means that existing ``local.conf`` files will need to be be modified to 15means that existing ``local.conf`` files will need to be modified to
16append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu`` 16append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu``
17instead of setting it. In other words, to enable graphical output for 17instead of setting it. In other words, to enable graphical output for
18QEMU, you should now have these lines in ``local.conf``: 18QEMU, you should now have these lines in ``local.conf``:
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index ed5a09a55d..107d06c76d 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -135,7 +135,7 @@ consists of the following pieces:
135 135
136- :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`: 136- :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`:
137 Runs tests against packages produced during the build for a given 137 Runs tests against packages produced during the build for a given
138 piece of software. The test allows the packages to be be run within a 138 piece of software. The test allows the packages to be run within a
139 target image. 139 target image.
140 140
141- ``oe-selftest``: Tests combination BitBake invocations. These tests 141- ``oe-selftest``: Tests combination BitBake invocations. These tests
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 9f423e7bb5..6edfa1a865 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -294,7 +294,7 @@ installer and automatically installs the tools for you:
294 294
295 During execution, the buildtools tarball will be downloaded, the 295 During execution, the buildtools tarball will be downloaded, the
296 checksum of the download will be verified, the installer will be run 296 checksum of the download will be verified, the installer will be run
297 for you, and some basic checks will be run to to make sure the 297 for you, and some basic checks will be run to make sure the
298 installation is functional. 298 installation is functional.
299 299
300 To avoid the need of ``sudo`` privileges, the ``install-buildtools`` 300 To avoid the need of ``sudo`` privileges, the ``install-buildtools``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f551c4d376..6a9fed0c68 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2991,7 +2991,7 @@ system and gives an overview of their function and contents.
2991 2991
2992 :term:`IMAGE_CMD` 2992 :term:`IMAGE_CMD`
2993 Specifies the command to create the image file for a specific image 2993 Specifies the command to create the image file for a specific image
2994 type, which corresponds to the value set set in 2994 type, which corresponds to the value set in
2995 :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, 2995 :term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
2996 ``btrfs``, and so forth). When setting this variable, you should use 2996 ``btrfs``, and so forth). When setting this variable, you should use
2997 an override for the associated type. Here is an example: 2997 an override for the associated type. Here is an example:
@@ -3458,7 +3458,7 @@ system and gives an overview of their function and contents.
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 licenses 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 licenses 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`