[PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence

[PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence

[Gyorgy Sarvari]

This commit[1] in pseudo introduced the PSEUDO_INCLUDE_PATHS variable, however
the previous PSEUDO_IGNORE_PATHS variable is still present also. Add a clarifying
note about the order of precedence of the two.

[1]: https://git.yoctoproject.org/pseudo/commit/?id=2c43381180f9cfef4c0a8bb0c1658a86c3fcc876

Signed-off-by: Gyorgy Sarvari <skandigraun@gmail.com>
---
 documentation/ref-manual/variables.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 1d4ec413ca..d180341079 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7567,7 +7567,9 @@ system and gives an overview of their function and contents.
       by pseudo when monitoring and recording file operations, in order to avoid
       problems with files being written to outside of the pseudo context and
       reduce pseudo's overhead. A path is ignored if it matches any prefix in the list
-      and can include partial directory (or file) names.
+      and can include partial directory (or file) names. In case a path prefix is
+      present in both this, and in :term:`PSEUDO_INCLUDE_PATHS` variable, then
+      the latter takes precedence.
 
    :term:`PSEUDO_INCLUDE_PATHS`
       A comma-separated (without spaces) list of path prefixes that should be included

Re: [docs] [PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence

[Antonin Godard]

On Fri Oct 10, 2025 at 4:23 PM CEST, Gyorgy Sarvari via lists.yoctoproject.org wrote:
> This commit[1] in pseudo introduced the PSEUDO_INCLUDE_PATHS variable, however
> the previous PSEUDO_IGNORE_PATHS variable is still present also. Add a clarifying
> note about the order of precedence of the two.
>
> [1]: https://git.yoctoproject.org/pseudo/commit/?id=2c43381180f9cfef4c0a8bb0c1658a86c3fcc876
>
> Signed-off-by: Gyorgy Sarvari <skandigraun@gmail.com>
> ---
>  documentation/ref-manual/variables.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 1d4ec413ca..d180341079 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -7567,7 +7567,9 @@ system and gives an overview of their function and contents.
>        by pseudo when monitoring and recording file operations, in order to avoid
>        problems with files being written to outside of the pseudo context and
>        reduce pseudo's overhead. A path is ignored if it matches any prefix in the list
> -      and can include partial directory (or file) names.
> +      and can include partial directory (or file) names. In case a path prefix is
> +      present in both this, and in :term:`PSEUDO_INCLUDE_PATHS` variable, then
> +      the latter takes precedence.
>  
>     :term:`PSEUDO_INCLUDE_PATHS`
>        A comma-separated (without spaces) list of path prefixes that should be included

In these kind of situations, I think a good way of being extra clear is:

"""
In case a path prefix is present in both :term:`PSEUDO_IGNORE_PATHS` and in
:term:`PSEUDO_INCLUDE_PATHS`, :term:`PSEUDO_INCLUDE_PATHS` takes precedence.
"""

What do you think?

Also, we could probably add the same sentence to PSEUDO_INCLUDE_PATHS's
description?

Thanks,
Antonin

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

Re: [docs] [PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence

[Gyorgy Sarvari]

On 10/13/25 12:44, Antonin Godard wrote:
> On Fri Oct 10, 2025 at 4:23 PM CEST, Gyorgy Sarvari via lists.yoctoproject.org wrote:
>> This commit[1] in pseudo introduced the PSEUDO_INCLUDE_PATHS variable, however
>> the previous PSEUDO_IGNORE_PATHS variable is still present also. Add a clarifying
>> note about the order of precedence of the two.
>>
>> [1]: https://git.yoctoproject.org/pseudo/commit/?id=2c43381180f9cfef4c0a8bb0c1658a86c3fcc876
>>
>> Signed-off-by: Gyorgy Sarvari <skandigraun@gmail.com>
>> ---
>>  documentation/ref-manual/variables.rst | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
>> index 1d4ec413ca..d180341079 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -7567,7 +7567,9 @@ system and gives an overview of their function and contents.
>>        by pseudo when monitoring and recording file operations, in order to avoid
>>        problems with files being written to outside of the pseudo context and
>>        reduce pseudo's overhead. A path is ignored if it matches any prefix in the list
>> -      and can include partial directory (or file) names.
>> +      and can include partial directory (or file) names. In case a path prefix is
>> +      present in both this, and in :term:`PSEUDO_INCLUDE_PATHS` variable, then
>> +      the latter takes precedence.
>>  
>>     :term:`PSEUDO_INCLUDE_PATHS`
>>        A comma-separated (without spaces) list of path prefixes that should be included
> In these kind of situations, I think a good way of being extra clear is:
>
> """
> In case a path prefix is present in both :term:`PSEUDO_IGNORE_PATHS` and in
> :term:`PSEUDO_INCLUDE_PATHS`, :term:`PSEUDO_INCLUDE_PATHS` takes precedence.
> """
>
> What do you think?
>
> Also, we could probably add the same sentence to PSEUDO_INCLUDE_PATHS's
> description?

Sure, v2 will come in minutes.

>
> Thanks,
> Antonin
>