[v3] ref-manual: Add documentation for the unimplemented-ptest QA warning

From: Jérémy Rosen <jeremy.rosen@smile.fr>

Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
---
Note: The code documented here has been sent to ML there:
https://lists.openembedded.org/g/openembedded-core/message/188892


 documentation/ref-manual/classes.rst   |  3 +++
 documentation/ref-manual/qa-checks.rst | 11 +++++++++++
 2 files changed, 14 insertions(+)

Hi Michael,

Le mar. 10 oct. 2023 à 15:53, Yoann Congal <yoann.congal@smile.fr> a écrit :
>
> From: Jérémy Rosen <jeremy.rosen@smile.fr>
>
> Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr>
> Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
> ---
> Note: The code documented here has been sent to ML there:
> https://lists.openembedded.org/g/openembedded-core/message/188892

FYi, the code part has been merged :
https://git.yoctoproject.org/poky/commit/?id=5330065f51fc0dcc2b74360220b2c97c4b80e622
https://git.yoctoproject.org/poky/commit/?id=18bd65d241d2ca2d14541b9c6dd0d9f3f1cdba35
https://git.yoctoproject.org/poky/commit/?id=f4b039cae0833634487607a4c6ade441dbe94cbf
https://git.yoctoproject.org/poky/commit/?id=b233e2f8c2d756010fd4fae5b8173b1fddf39693

Thanks!


>  documentation/ref-manual/classes.rst   |  3 +++
>  documentation/ref-manual/qa-checks.rst | 11 +++++++++++
>  2 files changed, 14 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 3f0d4844e..c7a5e9a63 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1480,6 +1480,9 @@ Here are the tests you can list with the :term:`WARN_QA` and
>     also inherits :ref:`ref-classes-features_check` in order for the
>     requirement to actually work.
>
> +-  ``unimplemented-ptest:`` Checks that ptests are implemented for upstream
> +   tests.
> +
>  -  ``unlisted-pkg-lics:`` Checks that all declared licenses applying
>     for a package are also declared on the recipe level (i.e. any license
>     in ``LICENSE:*`` should appear in :term:`LICENSE`).
> diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
> index 4a02e7206..63b2ecdc4 100644
> --- a/documentation/ref-manual/qa-checks.rst
> +++ b/documentation/ref-manual/qa-checks.rst
> @@ -789,6 +789,17 @@ Errors and Warnings
>      use a relative path rather than an absolute one, or to pick up the path from
>      runtime configuration or environment variables.
>
> +.. _qa-check-unimplemented-ptest:
> +
> +- ``<tool> tests detected [unimplemented-ptest]``
> +
> +    This check will detect if the source of the package contains some upstream-
> +    provided tests and, if so, that ptests are implemented for this recipe.
> +    See the ":ref:`dev-manual/packages:testing packages with ptest`"
> +    section in the Yocto Project Development Tasks Manual. See also the
> +    ":ref:`ref-classes-ptest`" section.
> +
> +
>
>  Configuring and Disabling QA Checks
>  ===================================
> --
> 2.30.2
>


--
Yoann Congal
Smile ECS - Tech expert

Yoann, Jérémy,
On 10.10.23 at 15:51, Yoann Congal wrote:
> From: Jérémy Rosen <jeremy.rosen@smile.fr>
>
> Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr>
> Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
> ---
> Note: The code documented here has been sent to ML there:
> https://lists.openembedded.org/g/openembedded-core/message/188892
>
>
>   documentation/ref-manual/classes.rst   |  3 +++
>   documentation/ref-manual/qa-checks.rst | 11 +++++++++++
>   2 files changed, 14 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 3f0d4844e..c7a5e9a63 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1480,6 +1480,9 @@ Here are the tests you can list with the :term:`WARN_QA` and
>      also inherits :ref:`ref-classes-features_check` in order for the
>      requirement to actually work.
>   
> +-  ``unimplemented-ptest:`` Checks that ptests are implemented for upstream
> +   tests.
> +
>   -  ``unlisted-pkg-lics:`` Checks that all declared licenses applying
>      for a package are also declared on the recipe level (i.e. any license
>      in ``LICENSE:*`` should appear in :term:`LICENSE`).
> diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
> index 4a02e7206..63b2ecdc4 100644
> --- a/documentation/ref-manual/qa-checks.rst
> +++ b/documentation/ref-manual/qa-checks.rst
> @@ -789,6 +789,17 @@ Errors and Warnings
>       use a relative path rather than an absolute one, or to pick up the path from
>       runtime configuration or environment variables.
>   
> +.. _qa-check-unimplemented-ptest:
> +
> +- ``<tool> tests detected [unimplemented-ptest]``
> +
> +    This check will detect if the source of the package contains some upstream-
> +    provided tests and, if so, that ptests are implemented for this recipe.

Here I put "upstream-provided" on the same line, to avoid having a space 
between the two words.

> +    See the ":ref:`dev-manual/packages:testing packages with ptest`"
> +    section in the Yocto Project Development Tasks Manual. See also the
> +    ":ref:`ref-classes-ptest`" section.


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into master-next.
Thanks again
Michael.