From 61ea9f7665d5c7d6b6dd4aeebb56519c83228c31 Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Mon, 18 Jul 2022 18:17:45 +0200 Subject: [PATCH] ref-manual: Add XZ_THREADS and XZ_MEMLIMIT XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell. [RP improved an original patch from Paul] (From yocto-docs rev: 4fb0498ecf1e6747ecd3ea5482d0b8bfa2632d49) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 49e756cfba..e184608d19 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -8745,4 +8745,22 @@ system and gives an overview of their function and contents. The default value of ``XSERVER``, if not specified in the machine configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". - + + :term:`XZ_THREADS` + Specifies the number of parallel threads that should be used when + using xz compression. + + By default this scales with core count, but is never set less than 2 + to ensure that multi-threaded mode is always used so that the output + file contents are deterministic. Builds will work with a value of 1 + but the output will differ compared to the output from the compression + generated when more than one thread is used. + + On systems where many tasks run in parallel, setting a limit to this + can be helpful in controlling system resource usage. + + :term:`XZ_MEMLIMIT` + Specifies the maximum memory the xz compression should use as a percentage + of system memory. If unconstrained the xz compressor can use large amounts of + memory and become problematic with parallelism elsewhere in the build. + "50%" has been found to be a good value.