From 809dd15c521a4bc2d7f51f4d67cb043d63c40d96 Mon Sep 17 00:00:00 2001
From: Nicolas Vollmar <nvollmar@gmail.com>
Date: Mon, 27 May 2024 20:11:32 +0200
Subject: T6406: document cpu limit config option

(cherry picked from commit 6742fa6314fdf448f814d18dac70a638587b75e6)
---
 docs/configuration/container/index.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst
index 4dacc6f4..39d7872c 100644
--- a/docs/configuration/container/index.rst
+++ b/docs/configuration/container/index.rst
@@ -133,6 +133,17 @@ Configuration
    - **always**: Restart containers when they exit, regardless of status,
      retrying indefinitely
 
+.. cfgcmd:: set container name <name> cpus <num>
+
+   This specifies the number of CPU resources the container can use.
+
+   Default is 0 for unlimited.
+   For example, 1.25 limits the container to use up to 1.25 cores
+   worth of CPU time.
+   This can be a decimal number with up to three decimal places.
+
+   The command translates to "--cpus=<num>" when the container is created.
+
 .. cfgcmd:: set container name <name> memory <MB>
 
    Constrain the memory available to the container.
-- 
cgit v1.2.3