[PATCH] dev-manual: emphasize that new layers live outside of poky

[PATCH] dev-manual: emphasize that new layers live outside of poky

[Robert P. J. Day]

Tweak the bblayers.conf example to encourage the reader to appreciate
that any new layers should not share space with the official Poky
checkout.

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

---

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 4a5011ea7..c23f8e09c 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -422,8 +422,9 @@ Before the OpenEmbedded build system can use your new layer, you need to
 enable it. To enable your layer, simply add your layer's path to the
 :term:`BBLAYERS` variable in your ``conf/bblayers.conf`` file, which is
 found in the :term:`Build Directory`.
-The following example shows how to enable a layer named
-``meta-mylayer``::
+The following example shows how to enable your new
+``meta-mylayer`` layer (note how your new layer exists outside of
+the official ``poky`` repository which you would have checked out earlier)::

    # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf
    # changes incompatibly
@@ -434,7 +435,7 @@ The following example shows how to enable a layer named
        /home/user/poky/meta \
        /home/user/poky/meta-poky \
        /home/user/poky/meta-yocto-bsp \
-       /home/user/poky/meta-mylayer \
+       /home/user/mystuff/meta-mylayer \
        "

 BitBake parses each ``conf/layer.conf`` file from the top down as

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: [docs] [PATCH] dev-manual: emphasize that new layers live outside of poky

[Quentin Schulz]

Hi Robert,

On Sun, Aug 29, 2021 at 05:42:31AM -0400, Robert P. J. Day wrote:
> Tweak the bblayers.conf example to encourage the reader to appreciate
> that any new layers should not share space with the official Poky
> checkout.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 

Reviewed-by: Quentin Schulz <foss@0leil.net>

On a similar topic, I assume we should change the "Adding a Layer Using
the ``bitbake-layers`` Script" section to have meta-scottrif in
/home/scottrif/. Basically outside of build directory at least :)

Cheers,
Quentin

Re: [docs] [PATCH] dev-manual: emphasize that new layers live outside of poky

[Robert P. J. Day]

On Mon, 30 Aug 2021, Quentin Schulz wrote:

> Hi Robert,
>
> On Sun, Aug 29, 2021 at 05:42:31AM -0400, Robert P. J. Day wrote:
> > Tweak the bblayers.conf example to encourage the reader to appreciate
> > that any new layers should not share space with the official Poky
> > checkout.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
>
> Reviewed-by: Quentin Schulz <foss@0leil.net>
>
> On a similar topic, I assume we should change the "Adding a Layer Using
> the ``bitbake-layers`` Script" section to have meta-scottrif in
> /home/scottrif/. Basically outside of build directory at least :)

  ah, quite so, i missed that. i'll take care of that later today.

rday

Re: [docs] [PATCH] dev-manual: emphasize that new layers live outside of poky

[Michael Opdenacker]

On 8/30/21 9:50 AM, Quentin Schulz wrote:
> Hi Robert,
>
> On Sun, Aug 29, 2021 at 05:42:31AM -0400, Robert P. J. Day wrote:
>> Tweak the bblayers.conf example to encourage the reader to appreciate
>> that any new layers should not share space with the official Poky
>> checkout.
>>
>> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>>
> Reviewed-by: Quentin Schulz <foss@0leil.net>


Merged into "master-next". Thanks for the patch and review!
Cheers,
Michael.

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