commit: a19fb91290af2e473990ba30ee64d96126b20b63
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Fri Nov 7 19:44:55 2025 +0000
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Fri Nov 7 19:44:55 2025 +0000
URL: https://gitweb.gentoo.org/proj/steve.git/commit/?id=a19fb912
Mention how to control job count in the README
Signed-off-by: Michał Górny <mgorny <AT> gentoo.org>
README.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.rst b/README.rst
index 76ae7c7..8ef0daa 100644
--- a/README.rst
+++ b/README.rst
@@ -36,3 +36,20 @@ the last process exits.
In the future, the control FIFO may be used to pass explicit commands
to steve.
+
+
+Adjusting the job count at runtime
+----------------------------------
+Due to the simplicity of the jobserver protocol, it is trivially
+possible to adjust the job count at runtime.
+
+To reduce the number of available jobs, read an appropriate number
+of characters from the pipe. For example, to lower the job count
+by 3 jobs, call::
+
+ read -L 3 < ${path_to_fifo}
+
+Similarly, to increase the number jobs, write an appropriate number
+of (any) characters to the pipe::
+
+ printf ... > ${path_to_fifo}