diff mbox series

[1/4] doc: bitbake-user-manual-ref-variables: clarify BBMASK directory matching

Message ID 20260211-bbmask-slashes-v1-1-b72161c647ef@cherry.de
State Accepted, archived
Commit c5311e24c6f3f0a3b02934520bc1e431455371e1
Headers show
Series doc: bitbake-user-manual-ref-variables: clarify BBMASK examples | expand

Commit Message

Quentin Schulz Feb. 11, 2026, 6:06 p.m. UTC
From: Quentin Schulz <quentin.schulz@cherry.de>

BBMASK matches files in the directories matching the regex, and also in
their respective subdirectories, so make that clear in the wording
leading to the example.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Antonin Godard Feb. 12, 2026, 8:49 a.m. UTC | #1
Hi,

On Wed Feb 11, 2026 at 7:06 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
>
> BBMASK matches files in the directories matching the regex, and also in
> their respective subdirectories, so make that clear in the wording
> leading to the example.
>
> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index 4b3b10d46..18bbd638d 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -1051,8 +1051,8 @@ overview of their function and contents.
>        documentation at http://docs.python.org/3/library/re.html.
>  
>        The following example uses a complete regular expression to tell
> -      BitBake to ignore all recipe and recipe append files in the
> -      ``meta-ti/recipes-misc/`` directory::
> +      BitBake to ignore all recipe and recipe append files in
> +      ``meta-ti/recipes-misc/`` directories (and their subdirectories)::

If I follow: this will mask multiple occurrences "meta-ti/recipes-misc/". How
could there be more than one in practice? How could this ever happen?

Wouldn't:

"""
The following example uses a complete regular expression to tell
BitBake to ignore all recipe and recipe append files in the
``meta-ti/recipes-misc/`` directory and its subdirectories::
"""

be less confusing?

Antonin
Quentin Schulz Feb. 12, 2026, 11:12 a.m. UTC | #2
Hi Antonin,

On 2/12/26 9:49 AM, Antonin Godard wrote:
> Hi,
> 
> On Wed Feb 11, 2026 at 7:06 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
>> From: Quentin Schulz <quentin.schulz@cherry.de>
>>
>> BBMASK matches files in the directories matching the regex, and also in
>> their respective subdirectories, so make that clear in the wording
>> leading to the example.
>>
>> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
>> ---
>>   doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> index 4b3b10d46..18bbd638d 100644
>> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
>> @@ -1051,8 +1051,8 @@ overview of their function and contents.
>>         documentation at http://docs.python.org/3/library/re.html.
>>   
>>         The following example uses a complete regular expression to tell
>> -      BitBake to ignore all recipe and recipe append files in the
>> -      ``meta-ti/recipes-misc/`` directory::
>> +      BitBake to ignore all recipe and recipe append files in
>> +      ``meta-ti/recipes-misc/`` directories (and their subdirectories)::
> 
> If I follow: this will mask multiple occurrences "meta-ti/recipes-misc/". How
> could there be more than one in practice? How could this ever happen?
> 

It's simply a path. There are no rules as to which layer can be named 
something. It also doesn't have to match a layer if the directory has 
meta in the name (meta-ti isn't a layer for example). There are no 
naming rules for where to put your recipes. You could very much have 
BBFILES with ${LAYERDIR}/appends-for-meta-ti/recipes-misc/*.bbappend for 
example.

FYI, there are two meta-rockchip layers in the wild. One maintained by 
Rockchip themselves, one maintained by Trevor. So it's not 
**impossible** (both share the same BBFILE_COLLECTIONS so you won't be 
able to have both included if I'm not mistaken, so that doesn't really 
apply here).

Also, I have written a meta-bsp layer in my vendor meta-cherry-es git 
repo, I'm probably not the only one having done that. What matters is 
that there's no BBFILE_COLLECTIONS name clash I think?

I hope this is better explained starting patch 3?

> Wouldn't:
> 
> """
> The following example uses a complete regular expression to tell
> BitBake to ignore all recipe and recipe append files in the
> ``meta-ti/recipes-misc/`` directory and its subdirectories::
> """
> 
> be less confusing?
> 

It's factually incorrect.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 4b3b10d46..18bbd638d 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1051,8 +1051,8 @@  overview of their function and contents.
       documentation at http://docs.python.org/3/library/re.html.
 
       The following example uses a complete regular expression to tell
-      BitBake to ignore all recipe and recipe append files in the
-      ``meta-ti/recipes-misc/`` directory::
+      BitBake to ignore all recipe and recipe append files in
+      ``meta-ti/recipes-misc/`` directories (and their subdirectories)::
 
          BBMASK = "meta-ti/recipes-misc/"