diff mbox series

[2/2] ref-manual: add ZSTD_THREADS

Message ID 20220422114602.2648543-2-richard.purdie@linuxfoundation.org
State New
Headers show
Series [1/2] ref-manual: Add XZ_THREADS and XZ_MEMLIMIT | expand

Commit Message

Richard Purdie April 22, 2022, 11:46 a.m. UTC 
ZSTD_THREADS is new for kirkstone.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0a5f8c98a..39b21f25e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8772,3 +8772,16 @@  system and gives an overview of their function and contents.
       memory and become problematic with parallelism elsewhere in the build.
       "50%" has been found to be a good value.
 
+   :term:`ZSTD_THREADS`
+      Specifies the number of parallel threads that should be used when
+      using ZStandard 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.
+