[PATCH 1/2] test-manual/intro: reorder bitbake-selftest steps

[PATCH 1/2] test-manual/intro: reorder bitbake-selftest steps

[Zachary T Welch]

The addition of the verbose example interrupted the description of the
BB_SKIP_NETTESTS option.

Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
---
 documentation/test-manual/intro.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
index eb9ebe2d5..c445e28a7 100644
--- a/documentation/test-manual/intro.rst
+++ b/documentation/test-manual/intro.rst
@@ -179,16 +179,16 @@ Tests map into the codebase as follows:
 
       $ bitbake-selftest
 
-   To skip tests that access the Internet, use the ``BB_SKIP_NETTESTS``
-   variable when running "bitbake-selftest" as follows::
-
-      $ BB_SKIP_NETTESTS=yes bitbake-selftest
-
    The default output is quiet and just prints a summary of what was
    run. To see more information, there is a verbose option::
 
       $ bitbake-selftest -v
 
+   To skip tests that access the Internet, use the ``BB_SKIP_NETTESTS``
+   variable when running "bitbake-selftest" as follows::
+
+      $ BB_SKIP_NETTESTS=yes bitbake-selftest
+
    Use this option when you wish to skip tests that access the network,
    which are mostly necessary to test the fetcher modules. To specify
    individual test modules to run, append the test module name to the
-- 
2.25.1

[PATCH 2/2] test-manual/intro: bitbake-selftest needs bitbake

[Zachary T Welch]

Without adding bitbake/bin to the PATH, some tests will fail when
they cannot find the main bitbake script.

Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
---
 documentation/test-manual/intro.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
index c445e28a7..12324e592 100644
--- a/documentation/test-manual/intro.rst
+++ b/documentation/test-manual/intro.rst
@@ -175,8 +175,14 @@ Tests map into the codebase as follows:
    which include the fetchers. The tests are located in
    ``bitbake/lib/*/tests``.
 
+   Some of these tests run the ``bitbake`` command, so ``bitbake/bin``
+   must be added to the ``PATH`` before running ``bitbake-selftest``.
    From within the BitBake repository, run the following::
 
+      $ export PATH=$PWD/bin:$PATH
+
+   After that, you can run the selftest script::
+
       $ bitbake-selftest
 
    The default output is quiet and just prints a summary of what was
-- 
2.25.1

Re: [docs] [PATCH 2/2] test-manual/intro: bitbake-selftest needs bitbake

[Michael Opdenacker]

Hi Zach

On 5/26/22 17:12, Zach Welch wrote:
> Without adding bitbake/bin to the PATH, some tests will fail when
> they cannot find the main bitbake script.
>
> Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
> ---
>  documentation/test-manual/intro.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
> index c445e28a7..12324e592 100644
> --- a/documentation/test-manual/intro.rst
> +++ b/documentation/test-manual/intro.rst
> @@ -175,8 +175,14 @@ Tests map into the codebase as follows:
>     which include the fetchers. The tests are located in
>     ``bitbake/lib/*/tests``.
>  
> +   Some of these tests run the ``bitbake`` command, so ``bitbake/bin``
> +   must be added to the ``PATH`` before running ``bitbake-selftest``.
>     From within the BitBake repository, run the following::
>  
> +      $ export PATH=$PWD/bin:$PATH
> +
> +   After that, you can run the selftest script::
> +
>        $ bitbake-selftest
>  
>     The default output is quiet and just prints a summary of what was


Many thanks for the two patches. For both of them:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into "master-next".

Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 2/2] test-manual/intro: bitbake-selftest needs bitbake

[Quentin Schulz]

Hi Zach,

On 5/26/22 17:12, Zach Welch wrote:
> Without adding bitbake/bin to the PATH, some tests will fail when
> they cannot find the main bitbake script.
> 
> Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
> ---
>   documentation/test-manual/intro.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
> 
> diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
> index c445e28a7..12324e592 100644
> --- a/documentation/test-manual/intro.rst
> +++ b/documentation/test-manual/intro.rst
> @@ -175,8 +175,14 @@ Tests map into the codebase as follows:
>      which include the fetchers. The tests are located in
>      ``bitbake/lib/*/tests``.
>   
> +   Some of these tests run the ``bitbake`` command, so ``bitbake/bin``
> +   must be added to the ``PATH`` before running ``bitbake-selftest``.
>      From within the BitBake repository, run the following::
>   
> +      $ export PATH=$PWD/bin:$PATH
> +


Since I think Bitbake won't work when there's a folder with a space in 
its name, I think it's fine not quoting it this way:
export PATH="$PWD/bin:$PATH"

So we should be good.

Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Thanks!
Quentin

Re: [docs] [PATCH 1/2] test-manual/intro: reorder bitbake-selftest steps

[Quentin Schulz]

Hi Zach,

On 5/26/22 17:12, Zach Welch wrote:
> The addition of the verbose example interrupted the description of the
> BB_SKIP_NETTESTS option.
> 
> Signed-off-by: Zachary T Welch <zach@aquabyte.ai>

Looks good to me,
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

Thanks!
Quentin