diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-03-23 17:58:45 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-06 22:29:49 +0100 |
commit | c643a4749c436baeb6943fe960f77a48deaef8e5 (patch) | |
tree | e79fda634aed23f488fedff8f74a0f2b321f28f9 /documentation/ref-manual | |
parent | 07c7bdc6c24974dfd4fdc50d142a5d2049966f5f (diff) | |
download | poky-c643a4749c436baeb6943fe960f77a48deaef8e5.tar.gz |
manuals: Spellcheck and capitalization fixes
- Spelling fixes found using Emacs' spelling checker
configured for US English
- Fixes for some capitalization issues, especially some
project names (QEMU, openSUSE, BusyBox), that were not
consistently used with the same capitalization anyway.
- A few whitespace fixes too
(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-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 |
6 files changed, 13 insertions, 13 deletions
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. |