[PATCH 0/2] Document some checks in externalsrc that could fail the build

[PATCH 0/2] Document some checks in externalsrc that could fail the build

[Talel BELHAJ SALEM]

Talel BELHAJ SALEM (2):
  dev-manual/building.rst: add note about globally inheriting
    externalsrc class
  dev-manual/building.rst: add note about externalsrc variables absolute
    paths

 documentation/dev-manual/building.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

-- 
2.51.0

[PATCH 1/2] dev-manual/building.rst: add note about globally inheriting externalsrc class

[Talel BELHAJ SALEM]

Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
---
 documentation/dev-manual/building.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index 04c150094..8d00d908e 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -736,6 +736,13 @@ are the statements to put in your ``local.conf`` file::
    INHERIT += "externalsrc"
    EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree"
 
+.. note::
+
+   When you inherit :ref:`ref-classes-externalsrc` class globally make
+   sure to set the :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
+   variables to specific recipes, not doing that will redirect
+   all recipes to one external source directory.
+
 This next example shows how to accomplish the same thing by setting
 :term:`EXTERNALSRC` in the recipe itself or in the recipe's append file::
 
-- 
2.51.0

Re: [docs] [PATCH 1/2] dev-manual/building.rst: add note about globally inheriting externalsrc class

[Antonin Godard]

On Sun Sep 21, 2025 at 3:20 PM CEST, BELHADJ SALEM Talel via lists.yoctoproject.org wrote:
> Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
> ---
>  documentation/dev-manual/building.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
> index 04c150094..8d00d908e 100644
> --- a/documentation/dev-manual/building.rst
> +++ b/documentation/dev-manual/building.rst
> @@ -736,6 +736,13 @@ are the statements to put in your ``local.conf`` file::
>     INHERIT += "externalsrc"
>     EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree"
>  
> +.. note::
> +
> +   When you inherit :ref:`ref-classes-externalsrc` class globally make
> +   sure to set the :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
> +   variables to specific recipes, not doing that will redirect
> +   all recipes to one external source directory.
> +
>  This next example shows how to accomplish the same thing by setting
>  :term:`EXTERNALSRC` in the recipe itself or in the recipe's append file::
>  

Hi,

When reading this, I had the feeling that the previous paragraph shows how to
set EXTERNALSRC for a specific recipe, and the next paragraph shows how to set
both EXTERNALSRC and EXTERNALSRC_BUILD from a recipe - which is exactly what you
say in your note. So, why a note to repeat this? What was the intent?

Antonin

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

Re: [docs] [PATCH 1/2] dev-manual/building.rst: add note about globally inheriting externalsrc class

[Talel BELHADJ SALEM]

[-- Attachment #1: Type: text/plain, Size: 1813 bytes --]

I think that beginners may not catch the idea from the example, and they,
accidentally, inherit globally without setting them to specific recipes.

Kind regards

On Mon, 22 Sep 2025 at 15:18 Antonin Godard <antonin.godard@bootlin.com>
wrote:

> On Sun Sep 21, 2025 at 3:20 PM CEST, BELHADJ SALEM Talel via
> lists.yoctoproject.org wrote:
> > Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
> > ---
> >  documentation/dev-manual/building.rst | 7 +++++++
> >  1 file changed, 7 insertions(+)
> >
> > diff --git a/documentation/dev-manual/building.rst
> b/documentation/dev-manual/building.rst
> > index 04c150094..8d00d908e 100644
> > --- a/documentation/dev-manual/building.rst
> > +++ b/documentation/dev-manual/building.rst
> > @@ -736,6 +736,13 @@ are the statements to put in your ``local.conf``
> file::
> >     INHERIT += "externalsrc"
> >     EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree"
> >
> > +.. note::
> > +
> > +   When you inherit :ref:`ref-classes-externalsrc` class globally make
> > +   sure to set the :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
> > +   variables to specific recipes, not doing that will redirect
> > +   all recipes to one external source directory.
> > +
> >  This next example shows how to accomplish the same thing by setting
> >  :term:`EXTERNALSRC` in the recipe itself or in the recipe's append
> file::
> >
>
> Hi,
>
> When reading this, I had the feeling that the previous paragraph shows how
> to
> set EXTERNALSRC for a specific recipe, and the next paragraph shows how to
> set
> both EXTERNALSRC and EXTERNALSRC_BUILD from a recipe - which is exactly
> what you
> say in your note. So, why a note to repeat this? What was the intent?
>
> Antonin
>
> --
> Antonin Godard, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>

[-- Attachment #2: Type: text/html, Size: 2673 bytes --]

Re: [docs] [PATCH 1/2] dev-manual/building.rst: add note about globally inheriting externalsrc class

[Antonin Godard]

On Mon Sep 22, 2025 at 8:08 PM CEST, BELHADJ SALEM Talel via lists.yoctoproject.org wrote:
> I think that beginners may not catch the idea from the example, and they,
> accidentally, inherit globally without setting them to specific recipes.

Understood. Then I would rephrase the sentence in the next paragraph after your
note, instead of adding the note.

Thanks,
Antonin

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

[PATCH 2/2] dev-manual/building.rst: add note about externalsrc variables absolute paths

[Talel BELHAJ SALEM]

Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com>
---
 documentation/dev-manual/building.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index 8d00d908e..de37704ad 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -764,6 +764,11 @@ to point to that directory::
 
    EXTERNALSRC_BUILD:pn-myrecipe = "path-to-your-source-tree"
 
+.. note::
+
+   The values of :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
+   must be absolute paths.
+
 Replicating a Build Offline
 ===========================
 
-- 
2.51.0

Re: [PATCH 2/2] dev-manual/building.rst: add note about externalsrc variables absolute paths

[Antonin Godard]

On Sun, 21 Sep 2025 14:20:33 +0100, Talel BELHAJ SALEM wrote:
> 


Applied, thanks!

[2/2] dev-manual/building.rst: add note about externalsrc variables absolute paths
      commit: 33166d70b6ad093bd95ffccafc0b07820682f656

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