aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2018-02-05 14:59:29 +0100
committerLudovic Courtès <ludo@gnu.org>2018-02-05 23:01:24 +0100
commita3025cad92054cb7399a7816a0696493396fc916 (patch)
tree144cb10c123de8aade42dffd534847f21a8fe091 /doc
parent161d6abef81784a1adb460d5bba40e03b627ceb2 (diff)
downloadcuirass-a3025cad92054cb7399a7816a0696493396fc916.tar
cuirass-a3025cad92054cb7399a7816a0696493396fc916.tar.gz
cuirass: Add '--threads' and put an upper bound on the default.
* bin/cuirass.in (show-help, %options): Add "--threads". (main): Honor it. Pass #:parallelism to 'run-fibers'.
Diffstat (limited to 'doc')
-rw-r--r--doc/cuirass.texi9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index ec81245..fcebef6 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -198,6 +198,15 @@ Wait @var{n} seconds between each poll.
This can be useful when you are not interested in building the
dependencies of a particular job.
+@item --threads=@var{n}
+Use up to @var{n} kernel threads.
+
+@var{n} should be lower than or equal to the number of CPU cores on the
+machine. In general though, having a large @var{n} is not very useful
+since the work of Cuirass is primarily I/O-bound---on the contrary,
+large values of @var{n} may increase overhead. The default value should
+be appropriate for most cases.
+
@item --version
@itemx -V
Display the actual version of @code{cuirass}.