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

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

[Zoltán Böszörményi]

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
+configuration to include support for OpenPGP signing. That may
+be done either in a recipe addendum called ``rpm_%.bbappend``:
+
+   PACKAGECONFIG:append = " sequoia"
+
+or in either your ``local.config`` or ``distro.config`` 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::
 
    # Inherit sign_rpm.bbclass to enable signing functionality
    INHERIT += " sign_rpm"
-- 
2.48.1

[PATCH 2/2] release-notes-5.2: add information about rpm and sequoia

[Zoltán Böszörményi]

Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com>
---
 documentation/migration-guides/release-notes-5.2.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst
index 06dce8d17..b0e538700 100644
--- a/documentation/migration-guides/release-notes-5.2.rst
+++ b/documentation/migration-guides/release-notes-5.2.rst
@@ -226,6 +226,9 @@ New Features / Enhancements in |yocto-ver|
    -  ``package_rpm``: restrict RPM packaging to 4 threads to improve
       the compression speed.
 
+   -  ``sign_rpm``: ``rpm`` needs the ``sequoia`` :term:`PACKAGECONFIG`
+      config set to be able to generate signed packages.
+
 -  LLVM related changes:
 
 -  SPDX-related changes:
@@ -300,6 +303,7 @@ New Features / Enhancements in |yocto-ver|
       -  ``gdk-pixbuf``: ``gif``, ``others``
       -  ``libpam``: ``selinux``
       -  ``libsecret``: ``pam``
+      -  ``rpm``: ``sequoia``
 
 -  Miscellaneous changes:
 
-- 
2.48.1

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

[Antonin Godard]

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

Re: [docs] [PATCH 2/2] release-notes-5.2: add information about rpm and sequoia

[Antonin Godard]

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/migration-guides/release-notes-5.2.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst
> index 06dce8d17..b0e538700 100644
> --- a/documentation/migration-guides/release-notes-5.2.rst
> +++ b/documentation/migration-guides/release-notes-5.2.rst
> @@ -226,6 +226,9 @@ New Features / Enhancements in |yocto-ver|
>     -  ``package_rpm``: restrict RPM packaging to 4 threads to improve
>        the compression speed.
>  
> +   -  ``sign_rpm``: ``rpm`` needs the ``sequoia`` :term:`PACKAGECONFIG`
> +      config set to be able to generate signed packages.
> +
>  -  LLVM related changes:
>  
>  -  SPDX-related changes:
> @@ -300,6 +303,7 @@ New Features / Enhancements in |yocto-ver|
>        -  ``gdk-pixbuf``: ``gif``, ``others``
>        -  ``libpam``: ``selinux``
>        -  ``libsecret``: ``pam``
> +      -  ``rpm``: ``sequoia``
>  
>  -  Miscellaneous changes:
>  

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

Thank you!
Antonin

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

[PATCH v2] dev-manual/packages: add information about signing changes

[Zoltán Böszörményi]

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..8845bf2fa 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``
+recipe configuration to include support for OpenPGP signing.
+That may be done either in a ``.bbappend`` for the ``rpm`` recipe::
+
+   PACKAGECONFIG:append = " sequoia"
+
+or in a :term:`Configuration File`::
+
+   PACKAGECONFIG:append:pn-rpm-native = " sequoia"
+   PACKAGECONFIG:append:pn-rpm = " sequoia"
+
+You must also set up the following settings in a
+:term:`Configuration File`::
 
    # Inherit sign_rpm.bbclass to enable signing functionality
    INHERIT += " sign_rpm"
-- 
2.48.1

Re: [PATCH v2] dev-manual/packages: add information about signing changes

[Antonin Godard]

Hi Zoltán,

On Thu Jan 30, 2025 at 10:04 AM CET, Zoltán Böszörményi 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..8845bf2fa 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``
> +recipe configuration to include support for OpenPGP signing.
> +That may be done either in a ``.bbappend`` for the ``rpm`` recipe::
> +
> +   PACKAGECONFIG:append = " sequoia"
> +
> +or in a :term:`Configuration File`::
> +
> +   PACKAGECONFIG:append:pn-rpm-native = " sequoia"
> +   PACKAGECONFIG:append:pn-rpm = " sequoia"
> +
> +You must also set up the following settings in a
> +:term:`Configuration File`::
>  
>     # Inherit sign_rpm.bbclass to enable signing functionality
>     INHERIT += " sign_rpm"

Looking good, thanks!

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

Antonin

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

Re: [PATCH v2] dev-manual/packages: add information about signing changes

[Antonin Godard]

Applied, thanks!

[1/1] dev-manual/packages: add information about signing changes
      commit: 6c1a77e5db7ae9910d24deb023619b9391c8b4ad

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>