summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuey-Lin Hsu <petercommand@gmail.com>2016-08-04 13:41:57 +0200
committerBen Gamari <ben@smart-cactus.org>2016-08-05 10:40:45 +0200
commitf09d65474ed042360999cb88221d65b07bfb4b5f (patch)
treecbecdd42cf26e33b4c9760cad75820f6f381b7fb /docs
parentfe4008f6cc51612c2511cf23fcd646bc23ef91b8 (diff)
downloadhaskell-f09d65474ed042360999cb88221d65b07bfb4b5f.tar.gz
check that the number of parallel build is greater than 0
Fixes #12062. Reviewers: bgamari, thomie, austin, simonmar Reviewed By: bgamari, thomie, simonmar Subscribers: simonmar, thomie Differential Revision: https://phabricator.haskell.org/D2415 GHC Trac Issues: #12062
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/using.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/users_guide/using.rst b/docs/users_guide/using.rst
index 3d3ef34d02..1d7f52c8e6 100644
--- a/docs/users_guide/using.rst
+++ b/docs/users_guide/using.rst
@@ -418,7 +418,8 @@ The main advantages to using ``ghc --make`` over traditional
dependencies never get out of sync with the source.
- Using the :ghc-flag:`-j` flag, you can compile modules in parallel. Specify
- ``-j⟨N⟩`` to compile ⟨N⟩ jobs in parallel.
+ ``-j⟨N⟩`` to compile ⟨N⟩ jobs in parallel. If N is omitted,
+ then it defaults to the number of processors.
Any of the command-line options described in the rest of this chapter
can be used with ``--make``, but note that any options you give on the
@@ -444,11 +445,12 @@ The source files for the program don't all need to be in the same
directory; the :ghc-flag:`-i` option can be used to add directories to the
search path (see :ref:`search-path`).
-.. ghc-flag:: -j <N>
+.. ghc-flag:: -j [N]
Perform compilation in parallel when possible. GHC will use up to ⟨N⟩
- threads during compilation. Note that compilation of a module may not
- begin until its dependencies have been built.
+ threads during compilation. If N is omitted, then it defaults to the
+ number of processors. Note that compilation of a module may not begin
+ until its dependencies have been built.
.. _eval-mode: