Re: [docs] [PATCH 1/2] dev-manual/packages: add information about signing changes

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Zoltán,

On Wed Jan 29, 2025 at 3:18 PM CET, Zoltan Boszormenyi via lists.yoctoproject.org wrote:
> Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com>
> ---
>  documentation/dev-manual/packages.rst | 16 +++++++++++++---
>  1 file changed, 13 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst
> index 4ba2dcae3..dba07a2c6 100644
> --- a/documentation/dev-manual/packages.rst
> +++ b/documentation/dev-manual/packages.rst
> @@ -819,9 +819,19 @@ to use signed package feeds (repositories) when doing a build.
>  Signing RPM Packages
>  --------------------
>  
> -To enable signing RPM packages, you must set up the following
> -configurations in either your ``local.config`` or ``distro.config``
> -file::
> +To enable signing RPM packages, you must modify the RPM package

I would rephrase to

"""
you must modify the ``rpm`` recipe configuration to include...
"""

Because PACKAGECONFIG is a recipe-level variable, not a package-level variable.

> +configuration to include support for OpenPGP signing. That may
> +be done either in a recipe addendum called ``rpm_%.bbappend``:

This should end with :: for the code block below.

I would rather say

"""
in a ``.bbappend`` for the ``rpm`` recipe::
"""

Two reasons:

* ``.bbappend`` seems to be the most used way in the docs to denote a bbappend
* I think it's best to avoid encouraging people to use % for bbappends

> +
> +   PACKAGECONFIG:append = " sequoia"
> +
> +or in either your ``local.config`` or ``distro.config`` file:

This should end with :: for the code block below.

Not your fault, but modifying local.conf is also something we try not to
encourage. And in any case, `local.config` is not a known conf file (local.conf
is).

So I would just say:

"""
...or in a :term:`Configuration File`::
"""

> +
> +   PACKAGECONFIG:append:pn-rpm-native = " sequoia"
> +   PACKAGECONFIG:append:pn-rpm = " sequoia"
> +
> +You must also set up the following configurations in either your
> +``local.config`` or ``distro.config`` file::

Same here as above.

>
>     # Inherit sign_rpm.bbclass to enable signing functionality
>     INHERIT += " sign_rpm"

Thank you,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com