From c643a4749c436baeb6943fe960f77a48deaef8e5 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 23 Mar 2021 17:58:45 +0100 Subject: 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 Reviewed-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/ref-manual/kickstart.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/resources.rst | 4 ++-- documentation/ref-manual/structure.rst | 2 +- documentation/ref-manual/system-requirements.rst | 2 +- documentation/ref-manual/variables.rst | 12 ++++++------ 6 files changed, 13 insertions(+), 13 deletions(-) (limited to 'documentation/ref-manual') 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 following syntax: :: - part [mntpoint] + part [mntpoint] partition [mntpoint] If you do not @@ -55,7 +55,7 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or .. note:: The mount program must understand the PARTUUID syntax you use with - ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox + ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox versions of these application are currently excluded. 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 - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. - 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. - ``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. -- 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. +- 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. - 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. - 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 Internet Relay Chat (IRC) ========================= -Two IRC channels on freenode are available for the Yocto Project and +Two IRC channels on Freenode are available for the Yocto Project and Poky discussions: - ``#yocto`` @@ -189,7 +189,7 @@ Here is a list of resources you might find helpful: implementation of Bugzilla for logging and tracking Yocto Project defects. -- *Internet Relay Chat (IRC):* Two IRC channels on freenode are +- *Internet Relay Chat (IRC):* Two IRC channels on Freenode are available for Yocto Project and Poky discussions: ``#yocto`` and ``#poky``, respectively. 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: meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86-64' + You can also run generated QEMU images with a command like 'runqemu qemux86-64' The default output of the ``oe-init-build-env`` script is from the ``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: - Debian GNU/Linux 10.x (Buster) -- OpenSUSE Leap 15.1 +- openSUSE Leap 15.1 .. 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. and new for generating new keys. :term:`FIT_KEY_SIGN_PKCS` - Format for public key ceritifcate used in signing fitImage. + Format for public key certificate used in signing fitImage. The default value is "x509". :term:`FIT_SIGN_ALG` @@ -3449,7 +3449,7 @@ system and gives an overview of their function and contents. It is possible to define a list of licenses that are allowed to be used instead of the licenses that are excluded. To do this, define - a variable ``COMPATIBLE_LICENSES`` with the names of the licences + a variable ``COMPATIBLE_LICENSES`` with the names of the licenses that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: :: @@ -3457,8 +3457,8 @@ system and gives an overview of their function and contents. This will result in ``INCOMPATIBLE_LICENSE`` containing the names of - all licences from :term:`AVAILABLE_LICENSES` except the ones specified - in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to + all licenses from :term:`AVAILABLE_LICENSES` except the ones specified + in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licenses to be used. :term:`INHERIT` @@ -5011,7 +5011,7 @@ system and gives an overview of their function and contents. ${PN}-${PV} :term:`PACKAGE_ADD_METADATA` - This variable defines additional metdata to add to packages. + This variable defines additional metadata to add to packages. You may find you need to inject additional metadata into packages. 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. - ``git://`` - Fetches files from a Git revision control repository. - - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service) + - ``osc://`` - Fetches files from an OSC (openSUSE Build service) revision control repository. - ``repo://`` - Fetches files from a repo (Git) repository. -- cgit v1.2.3-54-g00ecf