diff mbox series

dev-manual: clarify use of "PACKAGE_ARCH" in a packagegroup

Message ID eeebe32f-3a88-90e7-555f-96ada6016c5f@crashcourse.ca
State New
Headers show
Series dev-manual: clarify use of "PACKAGE_ARCH" in a packagegroup | expand

Commit Message

Robert P. J. Day June 16, 2026, 1:17 p.m. UTC
Warn the developer that if they need to set "PACKAGE_ARCH" in a
custom packagegroup file, that setting must precede the "inherit
packagegroup" line in the packagegroup recipe file.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Comments

Antonin Godard June 16, 2026, 3:06 p.m. UTC | #1
Hi,

On Tue Jun 16, 2026 at 3:17 PM CEST, Robert P. J. Day wrote:
>
> Warn the developer that if they need to set "PACKAGE_ARCH" in a
> custom packagegroup file, that setting must precede the "inherit
> packagegroup" line in the packagegroup recipe file.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst
> index 6eed9ef56..606252fe1 100644
> --- a/documentation/dev-manual/customizing-images.rst
> +++ b/documentation/dev-manual/customizing-images.rst
> @@ -183,6 +183,18 @@ build an image using these package group packages, you need to add
>  :term:`IMAGE_INSTALL`. For other forms of image dependencies see the other
>  areas of this section.
>
> +.. note::
> +
> +   If you're defining a packagegroup and need to set::
> +
> +      PACKAGE_ARCH = "${MACHINE_ARCH}"
> +
> +   for the packagegroup, you need to do that *before* the
> +   ``inherit packagegroup`` line in the recipe file.
> +   Setting it afterward can break BitBake parsing, result in
> +   an "allarch" architecture mismatch error, or allow
> +   architecture-independent defaults to override your intent.
> +
>  Customizing an Image Hostname
>  =============================

Again, I think this belongs to the packagegroup class documentation.

Antonin
Robert P. J. Day June 16, 2026, 4:24 p.m. UTC | #2
On Tue, 16 Jun 2026, Antonin Godard wrote:

> Hi,
>
> On Tue Jun 16, 2026 at 3:17 PM CEST, Robert P. J. Day wrote:
> >
> > Warn the developer that if they need to set "PACKAGE_ARCH" in a
> > custom packagegroup file, that setting must precede the "inherit
> > packagegroup" line in the packagegroup recipe file.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
> > ---
> >
> > diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst
> > index 6eed9ef56..606252fe1 100644
> > --- a/documentation/dev-manual/customizing-images.rst
> > +++ b/documentation/dev-manual/customizing-images.rst
> > @@ -183,6 +183,18 @@ build an image using these package group packages, you need to add
> >  :term:`IMAGE_INSTALL`. For other forms of image dependencies see the other
> >  areas of this section.
> >
> > +.. note::
> > +
> > +   If you're defining a packagegroup and need to set::
> > +
> > +      PACKAGE_ARCH = "${MACHINE_ARCH}"
> > +
> > +   for the packagegroup, you need to do that *before* the
> > +   ``inherit packagegroup`` line in the recipe file.
> > +   Setting it afterward can break BitBake parsing, result in
> > +   an "allarch" architecture mismatch error, or allow
> > +   architecture-independent defaults to override your intent.
> > +
> >  Customizing an Image Hostname
> >  =============================
>
> Again, I think this belongs to the packagegroup class documentation.

  ah, the "class" documentation.  got it.

rday
diff mbox series

Patch

diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst
index 6eed9ef56..606252fe1 100644
--- a/documentation/dev-manual/customizing-images.rst
+++ b/documentation/dev-manual/customizing-images.rst
@@ -183,6 +183,18 @@  build an image using these package group packages, you need to add
 :term:`IMAGE_INSTALL`. For other forms of image dependencies see the other
 areas of this section.

+.. note::
+
+   If you're defining a packagegroup and need to set::
+
+      PACKAGE_ARCH = "${MACHINE_ARCH}"
+
+   for the packagegroup, you need to do that *before* the
+   ``inherit packagegroup`` line in the recipe file.
+   Setting it afterward can break BitBake parsing, result in
+   an "allarch" architecture mismatch error, or allow
+   architecture-independent defaults to override your intent.
+
 Customizing an Image Hostname
 =============================