From f3540fc691c12aca637ddea71bd0090ddcc40e19 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 5 May 2021 15:25:20 +0200 Subject: manuals: reduce verbosity with "worry about" expression (From yocto-docs rev: 6c65f5f350cdc79a435deb20c48d861d9f4c5c14) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie --- documentation/dev-manual/common-tasks.rst | 4 ++-- documentation/kernel-dev/common.rst | 4 ++-- documentation/ref-manual/classes.rst | 4 ++-- documentation/ref-manual/structure.rst | 2 +- documentation/toaster-manual/reference.rst | 5 ++--- 5 files changed, 9 insertions(+), 10 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 37c7a19bfa..4200b8dd61 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -1589,7 +1589,7 @@ your software is built: - *Autotools:* If your source files have a ``configure.ac`` file, then your software is built using Autotools. If this is the case, you just - need to worry about modifying the configuration. + need to modify the configuration. When using Autotools, your recipe needs to inherit the :ref:`autotools ` class @@ -1603,7 +1603,7 @@ your software is built: - *CMake:* If your source files have a ``CMakeLists.txt`` file, then your software is built using CMake. If this is the case, you just - need to worry about modifying the configuration. + need to modify the configuration. When you use CMake, your recipe needs to inherit the :ref:`cmake ` class and your diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 5935d6f560..cea3ce7405 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -589,8 +589,8 @@ recipe is processed. In general, however, the Yocto Project maintainers take care of moving the ``SRC_URI``-specified configuration options to the - kernel's ``meta`` branch. Not only is it easier for BSP developers to - not have to worry about putting those configurations in the branch, + kernel's ``meta`` branch. Not only is it easier for BSP developers + not to have to put those configurations in the branch, but having the maintainers do it allows them to apply 'global' knowledge about the kinds of common configuration options multiple BSPs in the tree are typically using. This allows for promotion of diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 9a1fc2c93f..a6347449f1 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -1260,8 +1260,8 @@ The following list shows the tests you can list with the ``WARN_QA`` and .. note:: - If you are not using runtime package management on your target - system, then you do not need to worry about this situation. + This is only relevant when you are using runtime package management + on your target system. - ``xorg-driver-abi:`` Checks that all packages containing Xorg drivers have ABI dependencies. The ``xserver-xorg`` recipe provides diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 6bcb6359f2..2106a8083b 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -38,7 +38,7 @@ usually matches the current stable BitBake release from the BitBake project. BitBake, a :term:`Metadata` interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. Failures are usually caused by errors in your Metadata and not from BitBake -itself; consequently, most users do not need to worry about BitBake. +itself. When you run the ``bitbake`` command, the main BitBake executable (which resides in the ``bitbake/bin/`` directory) starts. Sourcing the diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index 3d4efe92d6..5d52c449cd 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst @@ -32,9 +32,8 @@ through a `REST `__ API, store the information about the layers in the Toaster database, and then show the information to users. Users are then able to view that -information and build layers from Toaster itself without worrying about -cloning or editing the BitBake layers configuration file -``bblayers.conf``. +information and build layers from Toaster itself without having to +clone or edit the BitBake layers configuration file ``bblayers.conf``. Tying a layer source into Toaster is convenient when you have many custom layers that need to be built on a regular basis by a community of -- cgit v1.2.3-54-g00ecf