diff mbox series

[1/3] doc: fix a few typos

Message ID 20251203-doc-file-include-require-v1-1-fc708832b475@cherry.de
State New
Headers show
Series doc: bitbake-user-manual: few fixes related to locating include files | expand

Commit Message

Quentin Schulz Dec. 3, 2025, 5:06 p.m. UTC
From: Quentin Schulz <quentin.schulz@cherry.de>

Some spurious whitespaces, bad grammar and typo are fixed here.

Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation")
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 doc/bitbake-user-manual/bitbake-user-manual-intro.rst    | 4 ++--
 doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Antonin Godard Dec. 4, 2025, 1:16 p.m. UTC | #1
On Wed Dec 3, 2025 at 6:06 PM CET, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
>
> Some spurious whitespaces, bad grammar and typo are fixed here.
>
> Fixes: 7bd36f6c6d33 ("doc: extend classes and include/require documentation")
> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-intro.rst    | 4 ++--
>  doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> index 9837b009e..2875e18f3 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> @@ -213,7 +213,7 @@ BitBake supports class files installed in three different directories:
>  
>  -  ``classes-global/``: these classes must be inherited globally through the
>     :term:`INHERIT` variable in a :ref:`configuration file
> -   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`.  These
> +   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`. These
>     classes are included for every recipe being built. For example, you would use
>     the global class named ``myclass`` like so::
>  
> @@ -227,7 +227,7 @@ BitBake supports class files installed in three different directories:
>        inherit myclass
>  
>  -  ``classes/``: this final directory is meant for classes that can be used in
> -   the two contexts explain above. In other words, they can be inherit either
> +   the two contexts explain above. In other words, they can be inherited either
>     globally or in a recipe.
>  
>  For details on how BitBake locates class files, see the
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index e5075a346..ef8ab024d 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -1060,7 +1060,7 @@ Additionally, BitBake searches the current directory for :ref:`include
>  
>  .. note::
>  
> -   The BBPATH variable is analogous to the environment variable PATH .
> +   The BBPATH variable is analogous to the environment variable PATH.
>  
>  For these two directives, BitBake includes the first file it finds.
>  
> @@ -1135,7 +1135,7 @@ would be searched in this order::
>  
>  .. note::
>  
> -   Note that the order of the list above does not depend on where the class in
> +   Note that the order of the list above does not depend on where the class is
>     inherited from.
>  
>  Likewise, for classes inherited with the :term:`INHERIT` variable, the

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index 9837b009e..2875e18f3 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -213,7 +213,7 @@  BitBake supports class files installed in three different directories:
 
 -  ``classes-global/``: these classes must be inherited globally through the
    :term:`INHERIT` variable in a :ref:`configuration file
-   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`.  These
+   <bitbake-user-manual/bitbake-user-manual-intro:Configuration Files>`. These
    classes are included for every recipe being built. For example, you would use
    the global class named ``myclass`` like so::
 
@@ -227,7 +227,7 @@  BitBake supports class files installed in three different directories:
       inherit myclass
 
 -  ``classes/``: this final directory is meant for classes that can be used in
-   the two contexts explain above. In other words, they can be inherit either
+   the two contexts explain above. In other words, they can be inherited either
    globally or in a recipe.
 
 For details on how BitBake locates class files, see the
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index e5075a346..ef8ab024d 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -1060,7 +1060,7 @@  Additionally, BitBake searches the current directory for :ref:`include
 
 .. note::
 
-   The BBPATH variable is analogous to the environment variable PATH .
+   The BBPATH variable is analogous to the environment variable PATH.
 
 For these two directives, BitBake includes the first file it finds.
 
@@ -1135,7 +1135,7 @@  would be searched in this order::
 
 .. note::
 
-   Note that the order of the list above does not depend on where the class in
+   Note that the order of the list above does not depend on where the class is
    inherited from.
 
 Likewise, for classes inherited with the :term:`INHERIT` variable, the