Commit 3d0804fa for xz
commit 3d0804faac7a9aaf55f87ef3d43713f4d1b724a1
Author: Lasse Collin <lasse.collin@tukaani.org>
Date: Wed Nov 11 12:34:43 2026 +0200
liblzma: Update API docs to mention cgroup v2 memory.max and cpu.max
diff --git a/src/liblzma/api/lzma/hardware.h b/src/liblzma/api/lzma/hardware.h
index 6b14a2e2..40c56a18 100644
--- a/src/liblzma/api/lzma/hardware.h
+++ b/src/liblzma/api/lzma/hardware.h
@@ -36,6 +36,9 @@
* usage limit for decompressing or how much memory it is OK to use
* for compressing.
*
+ * Since liblzma 5.8.5: On Linux, if cgroup v2 memory.max is lower than
+ * the amount of physical memory, the memory.max value is returned.
+ *
* \return On success, the total amount of physical memory in bytes
* is returned. If the amount of RAM cannot be determined,
* zero is returned. This can happen if an error occurs
@@ -52,6 +55,11 @@ extern LZMA_API(uint64_t) lzma_physmem(void) lzma_nothrow;
* If the hardware supports more than one thread per CPU core, the number
* of hardware threads is returned if that information is available.
*
+ * Since liblzma 5.8.5: On Linux, if cgroup v2 cpu.max is lower than the
+ * available hardware threads, the return value is the number of threads
+ * that can be fully utilitized without being throttled or at least 1 (in
+ * case cpu.max is less than 100 % of one core).
+ *
* \return On success, the number of available CPU threads or cores is
* returned. If this information isn't available or an error
* occurs, zero is returned.