summaryrefslogtreecommitdiff
path: root/docs/users_guide/using-concurrent.rst
diff options
context:
space:
mode:
authorÖmer Sinan Ağacan <omeragacan@gmail.com>2018-08-17 10:56:28 +0300
committerÖmer Sinan Ağacan <omeragacan@gmail.com>2018-08-17 10:56:38 +0300
commit23f6f31dd66d7c370cb8beec3f1d96a0cb577393 (patch)
treee2b1b6f760d699c4bdc45067a64e90d99b0c3ae6 /docs/users_guide/using-concurrent.rst
parenta50244c6a87176a4df8d41e6a1a3f102ba129032 (diff)
downloadhaskell-23f6f31dd66d7c370cb8beec3f1d96a0cb577393.tar.gz
Document default value of +RTS -N in user's guide
Summary: (This is documented in `+RTS -?` but wasn't documented in the user's guide) Reviewers: simonmar, bgamari, monoidal Reviewed By: monoidal Subscribers: rwbarton, carter Differential Revision: https://phabricator.haskell.org/D5065
Diffstat (limited to 'docs/users_guide/using-concurrent.rst')
-rw-r--r--docs/users_guide/using-concurrent.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/users_guide/using-concurrent.rst b/docs/users_guide/using-concurrent.rst
index e8640dcbc3..da27708b5d 100644
--- a/docs/users_guide/using-concurrent.rst
+++ b/docs/users_guide/using-concurrent.rst
@@ -133,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``.