commit: d96cfe1f385176d639d3d3d8a6106543d9ed1620
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Tue Nov 25 19:14:35 2025 +0000
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Tue Nov 25 19:14:35 2025 +0000
URL: https://gitweb.gentoo.org/proj/steve.git/commit/?id=d96cfe1f
README: add make.conf bits
Signed-off-by: Michał Górny <mgorny <AT> gentoo.org>
README.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README.rst b/README.rst
index f41d3da..5a1d8c6 100644
--- a/README.rst
+++ b/README.rst
@@ -39,6 +39,19 @@ Additionally, support files for OpenRC and systemd are
provided
in the ``data`` directory. All these bits are installed by the Gentoo
package.
+To use steve from a build system, one needs to set ``MAKEFLAGS``
+appropriately. To use it for all builds in Portage, these flags can
+be set in ``make.conf``::
+
+ MAKEFLAGS="--jobserver-auth=fifo:/dev/steve"
+
+Note that to use steve with Ninja, ``-j`` must not be passed. Given
+that ``MAKEOPTS`` is used to default other build systems, the best
+approach is to override ``NINJAOPTS``, e.g.::
+
+ MAKEOPTS="-j12 -l13"
+ NINJAOPTS="-l13"
+
To inspect the current status, ``SIGUSR1`` can be sent to steve::
$ killall -USR1 steve
