[2/2] docs: point to renamed BB_BASEHASH_IGNORE_VARS variable

Message ID 20220223105206.2766014-2-foss+yocto@0leil.net
State Accepted
Commit a6c6283e9cc30ca580f1719d8e22fca5f79c1e50
Headers show
Series [1/2] docs: fix hardcoded link warning messages | expand

Commit Message

Quentin Schulz Feb. 23, 2022, 10:52 a.m. UTC
From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

Since commit 98b3ed1b2e11 "meta/scripts: Handle bitbake variable
renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
so let's update it so that Sphinx can resolve the Bitbake reference.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/dev-manual/common-tasks.rst | 2 +-
 documentation/ref-manual/variables.rst    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Michael Opdenacker Feb. 23, 2022, 1:31 p.m. UTC | #1
Hi Quentin,

On 2/23/22 11:52, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> Since commit 98b3ed1b2e11 "meta/scripts: Handle bitbake variable
> renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
> so let's update it so that Sphinx can resolve the Bitbake reference.
>
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 2 +-
>  documentation/ref-manual/variables.rst    | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index fd394c3ae..c111355cc 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -9474,7 +9474,7 @@ BitBake has determined by doing the following:
>  
>     The output of ``bitbake-dumpsig`` also includes the value each
>     variable had, a list of dependencies for each variable, and
> -   :term:`BB_HASHBASE_WHITELIST`
> +   :term:`BB_BASEHASH_IGNORE_VARS`
>     information.
>  
>  There is also a ``bitbake-diffsigs`` command for comparing two
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 25a874f83..ecb2b60c7 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -763,7 +763,7 @@ system and gives an overview of their function and contents.
>  
>           export BBSERVER=localhost:$port
>  
> -      By default, :term:`BBSERVER` also appears in :term:`BB_HASHBASE_WHITELIST`.
> +      By default, :term:`BBSERVER` also appears in :term:`BB_BASEHASH_IGNORE_VARS`.
>        Consequently, :term:`BBSERVER` is excluded from checksum and dependency
>        data.
>  
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
and merged into master-next.
Thanks!
Michael.

Patch

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index fd394c3ae..c111355cc 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -9474,7 +9474,7 @@  BitBake has determined by doing the following:
 
    The output of ``bitbake-dumpsig`` also includes the value each
    variable had, a list of dependencies for each variable, and
-   :term:`BB_HASHBASE_WHITELIST`
+   :term:`BB_BASEHASH_IGNORE_VARS`
    information.
 
 There is also a ``bitbake-diffsigs`` command for comparing two
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 25a874f83..ecb2b60c7 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -763,7 +763,7 @@  system and gives an overview of their function and contents.
 
          export BBSERVER=localhost:$port
 
-      By default, :term:`BBSERVER` also appears in :term:`BB_HASHBASE_WHITELIST`.
+      By default, :term:`BBSERVER` also appears in :term:`BB_BASEHASH_IGNORE_VARS`.
       Consequently, :term:`BBSERVER` is excluded from checksum and dependency
       data.