summaryrefslogtreecommitdiff
path: root/docs/users_guide/using-concurrent.rst
diff options
context:
space:
mode:
authorKavon Farvardin <kavon@farvard.in>2018-09-23 15:29:37 -0500
committerKavon Farvardin <kavon@farvard.in>2018-09-23 15:29:37 -0500
commit84c2ad99582391005b5e873198b15e9e9eb4f78d (patch)
treecaa8c2f2ec7e97fbb4977263c6817c9af5025cf4 /docs/users_guide/using-concurrent.rst
parent8ddb47cfcf5776e9a3c55fd37947c8a95e00fa12 (diff)
parente68b439fe5de61b9a2ca51af472185c62ccb8b46 (diff)
downloadhaskell-wip/T13904.tar.gz
update to current master againwip/T13904
Diffstat (limited to 'docs/users_guide/using-concurrent.rst')
-rw-r--r--docs/users_guide/using-concurrent.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/users_guide/using-concurrent.rst b/docs/users_guide/using-concurrent.rst
index 32e24256c3..da27708b5d 100644
--- a/docs/users_guide/using-concurrent.rst
+++ b/docs/users_guide/using-concurrent.rst
@@ -76,6 +76,10 @@ the :ghc-flag:`-threaded` option (see :ref:`options-linker`). Additionally, the
following compiler options affect parallelism:
.. ghc-flag:: -feager-blackholing
+ :shortdesc: Turn on :ref:`eager blackholing <parallel-compile-options>`
+ :type: dynamic
+ :category:
+ :noindex:
Blackholing is the act of marking a thunk (lazy computation) as
being under evaluation. It is useful for three reasons: firstly it
@@ -129,6 +133,8 @@ use the RTS :rts-flag:`-N ⟨x⟩` options.
value of ⟨x⟩ itself based on how many processors are in your
machine.
+ Omitting ``-N⟨x⟩`` entirely means ``-N1``.
+
With ``-maxN⟨x⟩``, i.e. ``+RTS -maxN3 -RTS``, the runtime will choose
at most (x), also limited by the number of processors on the system.
Omitting (x) is an error, if you need a default use option ``-N``.