[oe] [meta-oe][PATCH] conf/layer.conf: conf/layer.conf: Document the operation on BBPATH correctly in the comment

[Khem Raj]

On Fri, May 6, 2011 at 3:36 PM, Gary Thomas <gary at mlbassoc.com> wrote:
> On 05/06/2011 04:25 PM, Paul Menzel wrote:
>>
>> Am Freitag, den 06.05.2011, 15:10 -0700 schrieb raj.khem at gmail.com:
>>>
>>> From: Khem Raj<raj.khem at gmail.com>
>>>
>>> Provide additional commentary that should help a bit more
>>>
>>> Signed-off-by: Khem Raj<raj.khem at gmail.com>
>>> ---
>>>  meta-efl/conf/layer.conf   |    2 +-
>>>  meta-gnome/conf/layer.conf |    2 +-
>>>  meta-gpe/conf/layer.conf   |    2 +-
>>>  meta-oe/conf/layer.conf    |   18 +++++++++++++++++-
>>>  4 files changed, 20 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/meta-efl/conf/layer.conf b/meta-efl/conf/layer.conf
>>> index f019337..272fc04 100644
>>> --- a/meta-efl/conf/layer.conf
>>> +++ b/meta-efl/conf/layer.conf
>>> @@ -1,4 +1,4 @@
>>> -# We have a conf and classes directory, prepend to BBPATH to prefer our
>>> versions
>>> +# We have a conf and classes directory, append to BBPATH
>>>  BBPATH .= ":${LAYERDIR}"
>>>
>>>  # We have a recipes directory, add to BBFILES
>>> diff --git a/meta-gnome/conf/layer.conf b/meta-gnome/conf/layer.conf
>>> index 6e8ff28..902ab8f 100644
>>> --- a/meta-gnome/conf/layer.conf
>>> +++ b/meta-gnome/conf/layer.conf
>>> @@ -1,4 +1,4 @@
>>> -# We have a conf and classes directory, prepend to BBPATH to prefer our
>>> versions
>>> +# We have a conf and classes directory, append to BBPATH
>>>  BBPATH .= ":${LAYERDIR}"
>>>
>>>  # We have a recipes directory, add to BBFILES
>>> diff --git a/meta-gpe/conf/layer.conf b/meta-gpe/conf/layer.conf
>>> index 006b6af..6c018b1 100644
>>> --- a/meta-gpe/conf/layer.conf
>>> +++ b/meta-gpe/conf/layer.conf
>>> @@ -1,4 +1,4 @@
>>> -# We have a conf and classes directory, prepend to BBPATH to prefer our
>>> versions
>>> +# We have a conf and classes directory, append to BBPATH
>>>  BBPATH .= ":${LAYERDIR}"
>>>
>>>  # We have a recipes directory, add to BBFILES
>>> diff --git a/meta-oe/conf/layer.conf b/meta-oe/conf/layer.conf
>>> index 36137e9..d5c2a17 100644
>>> --- a/meta-oe/conf/layer.conf
>>> +++ b/meta-oe/conf/layer.conf
>>> @@ -1,4 +1,14 @@
>>> -# We have a conf and classes directory, prepend to BBPATH to prefer our
>>> versions
>>> +# It really depends on order of the layers appearing in BBLAYERS
>>> +# variable in toplevel bblayers.conf file, where bitbake will search
>>> +# for .inc files and others where bitbake uses BBPATH since it will
>>> +# search the directories from first to last as specfied in BBPATH
>>
>> spec*i*fied
>>
>>> +# Therefore if you want a given layer to be considered high priority
>>> +# for the .inc and .conf etc. then consider it adding at the beginning
>>
>> … then consider adding it to the …
>>
>>> +# of BBPATH. For bblayers bitbake will use BBFILES_PRIORITY to resolve
>>> +# the recipe contention so the order of directories in BBFILES does
>>> +# not matter
>>
>> Full stop at the end?
>>
>>> +
>>> +# We have a conf and classes directory, append to BBPATH
>>>  BBPATH .= ":${LAYERDIR}"
>>>
>>>  # We have a recipes directory, add to BBFILES
>>> @@ -6,4 +16,10 @@ BBFILES += "${LAYERDIR}/recipes-*/*/*.bb
>>> ${LAYERDIR}/recipes-*/*/*.bbappend"
>>>
>>>  BBFILE_COLLECTIONS += "openembedded-layer"
>>>  BBFILE_PATTERN_openembedded-layer := "^${LAYERDIR}/"
>>> +
>>> +# Define the priority for recipes (.bb files) from this layer
>>
>> Add an extra line to make paragraph more clear or start with a capital
>> letter below?
>>
>>> +# this should be noted when you use this layer since it has
>>
>> Note sounds strange. Use »defined« again?
>>
>>> +# to fall into the correct layer priority order that you have decided
>>> +# for you layering model
>>
>> s/you/your/
>>
>>> +
>>>  BBFILE_PRIORITY_openembedded-layer = "6"
>>
>> Acked-by: Paul Menzel<paulepanter at users.sourceforge.net>
>>
>> But please wait a bit before pushing it. Maybe a native speaker will
>> read through the new comments.
>
> The corrections look fine, but I think that last bit should be
> worded more like this:
>
>  # Define the priority for recipes (.bb files) from this layer,
>  # choosing carefully how this layer interacts with all of the
>  # other layers.
>

thank you. Will redo it and incorporate feedback.

> n.b. I'm not convinced of the worth of layer priorities; I don't
> see what they gain and to me they only cause confusion...
>
Thats a different story :)
We are documenting what we have.
> --
> ------------------------------------------------------------
> Gary Thomas                 |  Consulting for the
> MLB Associates              |    Embedded world
> ------------------------------------------------------------
>
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel at lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel
>