File tree Expand file tree Collapse file tree 2 files changed +21
-10
lines changed Expand file tree Collapse file tree 2 files changed +21
-10
lines changed Original file line number Diff line number Diff line change @@ -101,9 +101,18 @@ configuration [option](yaml_configuration.md#install-ghc).
101
101
## ` --jobs ` or ` -j ` option
102
102
103
103
Pass the option ` --jobs <number_of_jobs> ` to specify the number of concurrent
104
- jobs to run. For further information, see the documentation for the
105
- corresponding non-project specific configuration
106
- [ option] ( yaml_configuration.md#jobs ) .
104
+ jobs (Stack actions during building) to run.
105
+
106
+ By default, Stack specifies a number of concurrent jobs equal to the number of
107
+ CPUs (cores) that the machine has. In some circumstances, that default can cause
108
+ some machines to run out of memory during building. If those circumstances
109
+ arise, specify ` --jobs 1 ` .
110
+
111
+ This configuration option is distinct from GHC's own ` -j[<n>] ` flag, which
112
+ relates to parallel compilation of modules within a package.
113
+
114
+ For further information, see the documentation for the corresponding non-project
115
+ specific configuration option: [ ` jobs ` ] ( yaml_configuration.md#jobs ) .
107
116
108
117
## ` --local-bin-path ` option
109
118
Original file line number Diff line number Diff line change @@ -906,16 +906,18 @@ Whether or not to automatically install GHC when necessary.
906
906
907
907
### jobs
908
908
909
- Default: the number of processors reported by your CPU .
909
+ Default: the number of CPUs (cores) that the machine has .
910
910
911
- Command line equivalent (takes precedence): ` -j ` , ` --jobs ` option
911
+ Command line equivalent (takes precedence):
912
+ [ ` -j ` , ` --jobs ` option] ( global_flags.md#-jobs-or--j-option )
912
913
913
- Specifies how many build tasks should be run in parallel. One usage for this
914
- might be to avoid running out of memory by setting it to 1, like this:
914
+ Specifies the number of concurrent jobs (Stack actions during building) to run.
915
915
916
- ~~~ yaml
917
- jobs : 1
918
- ~~~
916
+ In some circumstances, the default can cause some machines to run out of memory
917
+ during building. If those circumstances arise, specify ` jobs: 1 ` .
918
+
919
+ This configuration option is distinct from GHC's own ` -j[<n>] ` flag, which
920
+ relates to parallel compilation of modules within a package.
919
921
920
922
### local-bin-path
921
923
You can’t perform that action at this time.
0 commit comments