[PATCH v4 2/5] classes.rst: document openssl-native.bbclass

[PATCH v4 2/5] classes.rst: document openssl-native.bbclass

[Mikko Rapeli]

It sets various environment variables correctly for openssl-native.

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
---
 documentation/ref-manual/classes.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

v4: updated to :ref: syntax and simplified text

v3: no changes

v2: moved doc changes to separate patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 11e0d472e8..8a10e51eb7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1672,6 +1672,16 @@ one such example. However, being aware of this class can reduce the
 proliferation of different versions of similar classes across multiple
 layers.
 
+.. _ref-classes-openssl-native:
+
+``openssl-native.bbclass``
+==================
+
+The :ref:`openssl-native <ref-classes-openssl-native>` class supports using
+the native version of ``openssl`` built by the Yocto Project instead of the
+one provided by the build host distribution. For full certificate checking
+users should also add ``ca-certificates-native`` to :term:`DEPENDS`.
+
 .. _ref-classes-overlayfs:
 
 ``overlayfs.bbclass``
-- 
2.17.1

Re: [docs] [PATCH v4 2/5] classes.rst: document openssl-native.bbclass

[Michael Opdenacker]

Mikko, Quentin,


Thanks for the patch and documentation review.
Indeed, it's great to get documentation updates together with the code.

On 05.10.22 11:30, Mikko Rapeli wrote:
> It sets various environment variables correctly for openssl-native.
>
> Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
> ---
>   documentation/ref-manual/classes.rst | 10 ++++++++++
>   1 file changed, 10 insertions(+)
>
> v4: updated to :ref: syntax and simplified text
>
> v3: no changes
>
> v2: moved doc changes to separate patch
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 11e0d472e8..8a10e51eb7 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -1672,6 +1672,16 @@ one such example. However, being aware of this class can reduce the
>   proliferation of different versions of similar classes across multiple
>   layers.
>   
> +.. _ref-classes-openssl-native:
> +
> +``openssl-native.bbclass``
> +==================


Oops, here Sphinx complains that you don't have enough "=" characters to 
match the title length:
/home/mike/work/git/git.yoctoproject.org/yocto-docs/documentation/ref-manual/classes.rst:1678: 
WARNING: Title underline too short.

Fixed.

> +
> +The :ref:`openssl-native <ref-classes-openssl-native>` class supports using
> +the native version of ``openssl`` built by the Yocto Project instead of the
> +one provided by the build host distribution. For full certificate checking
> +users should also add ``ca-certificates-native`` to :term:`DEPENDS`.
> +
>   .. _ref-classes-overlayfs:


Looks good to me otherwise.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

... and waiting for the corresponding patches to be merged in OE-core 
before merging the change in the documentation.

Thanks again
Cheers
Michael.

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

Re: [docs] [PATCH v4 2/5] classes.rst: document openssl-native.bbclass

[Michael Opdenacker]

Hi Mikko,

On 10/5/22 18:42, Michael Opdenacker via lists.yoctoproject.org wrote:
>
> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> ... and waiting for the corresponding patches to be merged in OE-core 
> before merging the change in the documentation.
>

Still keeping an eye at Poky master for the appearance of 
openssl-native.bbclass, and keeping your changes in my local branch.
Don't hesitate ping me when you know this happened.

Thanks again
Michael.

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