How to increase the maximum threads in $*SCHEDULER

Explain the current default limit on hyperoperators and methods.
Raku · Jul 18, 2016 · f4843c3 · f4843c3
1 parent b676fce
commit f4843c3
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/doc/Language/variables.pod6 b/doc/Language/variables.pod6
@@ -1152,8 +1152,18 @@ X<|$*SPEC>X<|$*TMPDIR>X<|$*THREAD>X<|$*SCHEDULER>
     ------------------+--------------------------------------------
     $*THREAD          | A L<Thread> object representing the currently executing thread.
     ------------------+--------------------------------------------
-    $*SCHEDULER       | A L<ThreadPoolScheduler> object representing the current
-                      | default scheduler.
+    $*SCHEDULER       | A L<ThreadPoolScheduler> object representing the current default 
+                      | scheduler. 
+                      |
+                      | Note on usage: For the current Rakudo, by default this imposes a 
+                      | maximum of 16 threads on hyperoperators and methods such as
+                      | C<.hyper> and C<.race>. To change the maximum number of threads, either
+                      | set the environment variable RAKUDO_MAX_THREADS or create a scoped copy
+                      | with the default changed:
+                      | 
+                      | my $*SCHEDULER = ThreadPoolScheduler.new( max_threads => 64 );
+                      | 
+                      | This behavior is not tested in the spec tests and is subject to change.)
     ------------------+--------------------------------------------
 
 =end pod