Document default value of +RTS -N in user's guide
authorÖmer Sinan Ağacan <omeragacan@gmail.com>
Fri, 17 Aug 2018 07:56:28 +0000 (10:56 +0300)
committerÖmer Sinan Ağacan <omeragacan@gmail.com>
Fri, 17 Aug 2018 07:56:38 +0000 (10:56 +0300)
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

docs/users_guide/using-concurrent.rst

index e8640dc..da27708 100644 (file)
@@ -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``.