public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <skandigraun@gmail.com>, <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence
Date: Mon, 13 Oct 2025 12:44:38 +0200	[thread overview]
Message-ID: <DDH4SWMDF96V.357XHVKSKC1HA@bootlin.com> (raw)
In-Reply-To: <20251010142311.3509374-1-skandigraun@gmail.com>

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



  reply	other threads:[~2025-10-13 10:44 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-10 14:23 [PATCH] ref-manual/variables.rst: add note about PSEUDO ignore/include precedence Gyorgy Sarvari
2025-10-13 10:44 ` Antonin Godard [this message]
2025-10-13 13:20   ` [docs] " Gyorgy Sarvari

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DDH4SWMDF96V.357XHVKSKC1HA@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=skandigraun@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox