summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcelineVQ <matthewnhyatt@gmail.com>2015-12-23 01:23:33 +0100
committerBen Gamari <ben@smart-cactus.org>2015-12-23 10:05:39 +0100
commit7ed0da6cde909e662d09e1f39c3fccfa10f91a7f (patch)
tree5afdda1d857199b41a520db124083991daa04ae6 /docs
parented213ead5e92aa3c2ae830a00f06684a1028d3ad (diff)
downloadhaskell-7ed0da6cde909e662d09e1f39c3fccfa10f91a7f.tar.gz
Modify Nmax to maxN Trac #10728
Added test and changed -Nmax to -maxN, -n was taken Noticed strange -m behavoir and fixed -m from quietly ignoring being passed invalid opts, e.g. "-msasd" Reviewers: simonmar, hvr, austin, thomie, bgamari Reviewed By: hvr, thomie, bgamari Subscribers: bgamari, hvr, thomie, simonmar Differential Revision: https://phabricator.haskell.org/D1677 GHC Trac Issues: #10728
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/7.12.1-notes.rst5
-rw-r--r--docs/users_guide/using-concurrent.rst9
2 files changed, 10 insertions, 4 deletions
diff --git a/docs/users_guide/7.12.1-notes.rst b/docs/users_guide/7.12.1-notes.rst
index caa1d897a8..678a9778a8 100644
--- a/docs/users_guide/7.12.1-notes.rst
+++ b/docs/users_guide/7.12.1-notes.rst
@@ -40,6 +40,8 @@ The highlights, since the 7.10 branch, are:
- A rewritten (and greatly improved) pattern exhaustiveness checker
+- ``-maxN(x)`` added to compliment ``-N``
+
- GHC can run the interpreter in a separate process (see
:ref:`external-interpreter`), and the interpreter can now run profiled
code.
@@ -332,6 +334,9 @@ Runtime system
- Support for performance monitoring with PAPI has been dropped.
+- ``-maxN(x)`` flag added to compliment ``-N``, it will choose to use at most
+ (x) capabilities, limited by the number of processors as ``-N`` is.
+
Build system
~~~~~~~~~~~~
diff --git a/docs/users_guide/using-concurrent.rst b/docs/users_guide/using-concurrent.rst
index 2621afce0f..b2b235ad3e 100644
--- a/docs/users_guide/using-concurrent.rst
+++ b/docs/users_guide/using-concurrent.rst
@@ -110,11 +110,11 @@ There are two ways to run a program on multiple processors: call
RTS ``-N`` options.
``-N⟨x⟩``
-``-Nmax⟨x⟩``
+``-maxN⟨x⟩``
.. index::
single: -N⟨x⟩; RTS option
- single: -Nmax(x); RTS option
+ single: -maxN(x); RTS option
Use ⟨x⟩ simultaneous threads when running the program.
@@ -136,8 +136,9 @@ RTS ``-N`` options.
value of ⟨x⟩ itself based on how many processors are in your
machine.
- With Nmax⟨x⟩, i.e. ``+RTS -Nmax3 -RTS``, the runtime will choose at
- most (x), also limited by the number of processors on the system.
+ 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``.
Be careful when using all the processors in your machine: if some of
your processors are in use by other programs, this can actually harm