[RFC][PATCH] default-distrovars.inc: Set BBINCLUDELOGS to empty to disable printing failed task output multiple times

[RFC][PATCH] default-distrovars.inc: Set BBINCLUDELOGS to empty to disable printing failed task output multiple times

[Martin Jansa]

* the output is shown 3 times with default configuration and 5 times when --verbose
  is being used with knotty, there might be other use-cases where we actually need
  this, but until the logging is resolved better, setting this to empty looks like
  more reasonable option (considering that e.g. log.do_compile from chromium-x11
  can be over 50MB long, generating 150MB+ cooker log)

* more details in:
  https://bugzilla.yoctoproject.org/show_bug.cgi?id=14542

Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
---
 meta/conf/distro/include/default-distrovars.inc | 6 ++++--
 meta/conf/documentation.conf                    | 2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/meta/conf/distro/include/default-distrovars.inc b/meta/conf/distro/include/default-distrovars.inc
index f91df632d5..5035508b98 100644
--- a/meta/conf/distro/include/default-distrovars.inc
+++ b/meta/conf/distro/include/default-distrovars.inc
@@ -33,8 +33,10 @@ BB_GENERATE_MIRROR_TARBALLS ??= "0"
 
 NO32LIBS ??= "1"
 
-# Default to emitting logfiles if a build fails.
-BBINCLUDELOGS ??= "yes"
+# Default logger already emits logfiles if a build fails, setting this to any non-empty value would just include more copies (prefixed with "|") in the output
+# https://bugzilla.yoctoproject.org/show_bug.cgi?id=14542
+BBINCLUDELOGS ??= ""
+
 SDK_VERSION ??= "nodistro.0"
 DISTRO_VERSION ??= "nodistro.0"
 
diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index c5a38b0764..f4697e28d0 100644
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -88,7 +88,7 @@ BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are
 BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer."
 BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe."
 BBFILES[doc] = "List of recipe files used by BitBake to build software."
-BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure."
+BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure. Set to empty if you don't want to have 2nd copy of failed task output (prefixed with '|') in the cooker log."
 BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
 BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file."
 BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files."
-- 
2.32.0

Re: [OE-core] [RFC][PATCH] default-distrovars.inc: Set BBINCLUDELOGS to empty to disable printing failed task output multiple times

[Mike Crowe]

On Friday 03 September 2021 at 13:55:21 +0200, Martin Jansa wrote:
> * the output is shown 3 times with default configuration and 5 times when --verbose
>   is being used with knotty, there might be other use-cases where we actually need
>   this, but until the logging is resolved better, setting this to empty looks like
>   more reasonable option (considering that e.g. log.do_compile from chromium-x11
>   can be over 50MB long, generating 150MB+ cooker log)
> 
> * more details in:
>   https://bugzilla.yoctoproject.org/show_bug.cgi?id=14542
> 
> Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
> ---
>  meta/conf/distro/include/default-distrovars.inc | 6 ++++--
>  meta/conf/documentation.conf                    | 2 +-
>  2 files changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/meta/conf/distro/include/default-distrovars.inc b/meta/conf/distro/include/default-distrovars.inc
> index f91df632d5..5035508b98 100644
> --- a/meta/conf/distro/include/default-distrovars.inc
> +++ b/meta/conf/distro/include/default-distrovars.inc
> @@ -33,8 +33,10 @@ BB_GENERATE_MIRROR_TARBALLS ??= "0"
>  
>  NO32LIBS ??= "1"
>  
> -# Default to emitting logfiles if a build fails.
> -BBINCLUDELOGS ??= "yes"
> +# Default logger already emits logfiles if a build fails, setting this to any non-empty value would just include more copies (prefixed with "|") in the output
> +# https://bugzilla.yoctoproject.org/show_bug.cgi?id=14542
> +BBINCLUDELOGS ??= ""
> +
>  SDK_VERSION ??= "nodistro.0"
>  DISTRO_VERSION ??= "nodistro.0"
>  
> diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> index c5a38b0764..f4697e28d0 100644
> --- a/meta/conf/documentation.conf
> +++ b/meta/conf/documentation.conf
> @@ -88,7 +88,7 @@ BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are
>  BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer."
>  BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe."
>  BBFILES[doc] = "List of recipe files used by BitBake to build software."
> -BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure."
> +BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure. Set to empty if you don't want to have 2nd copy of failed task output (prefixed with '|') in the cooker log."
>  BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
>  BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file."
>  BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files."
> -- 
> 2.32.0

This patch (when applied to Dunfell) appears to solve the problem for me. I
now only get a single copy of the log output in both the output from
bitbake and the cooker log.

Whether it's the right solution or not I cannot say, though. :)

Thanks!

Mike.