Skip to content

Commit 5315ed0

Browse files
committed
Further document output options
1 parent dac4bd9 commit 5315ed0

File tree

2 files changed

+23
-14
lines changed

2 files changed

+23
-14
lines changed

doc/build_command.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,15 @@ package is targetted in a multi-package project (for example, using
285285
* **One target package:** The build output for the target package is sent to the
286286
console as it happens.
287287

288-
* **More than one target package:** The build output from GHC
289-
(as opposed to from Stack) for each target package is sent to a log file for
290-
that package, unless it contains warnings or errors. At the end of the build,
291-
the location of the directory containing the log files is reported. To also
292-
output the contents of the log files to the console at the end of the build,
293-
use Stack's `dump-logs` option. For further information about that option, see
294-
the [YAML configuration](yaml_configuration.md#dump-logs) documentation.
288+
* **More than one target package:** The build output from GHC (as opposed to
289+
from Stack) for each target package is sent to a log file for that package,
290+
unless an error occurs. At the end of the build, the location of the directory
291+
containing the log files is reported. To also output the contents of the log
292+
files to the console at the end of the build, use Stack's `dump-logs` option.
293+
For further information about that option, see the
294+
[YAML configuration](yaml_configuration.md#dump-logs) documentation. The
295+
default `dump-logs` mode is to output the contents of the log files that are
296+
warnings.
295297

296298
### The `stack build --pedantic` flag
297299

doc/yaml_configuration.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -620,17 +620,24 @@ Default: `warning`
620620

621621
Command line equivalent (takes precedence): `--[no-]dump-logs` flag
622622

623-
Control which log output from local non-dependency packages to print to the
624-
console. By default, Stack will only do this when building a single target
625-
package or if the log contains warnings, to avoid generating unnecessarily
626-
verbose output.
623+
In the case of *non-interleaved* output and *more than one* target package,
624+
Stack sends the build output from GHC for each target package to a log file,
625+
unless an error occurs. For further information, see the
626+
[`stack build --[no-\]interleaved-output` flag](build_command.md#the-stack-build---no-interleaved-output-flag)
627+
documentation.
628+
629+
The value of the `dump-logs` key controls what, if any, log file content is sent
630+
('dumped') to the console at the end of the build. Possible values are:
627631

628632
~~~yaml
629-
dump-logs: none # don't dump logs even if they contain warnings
630-
dump-logs: warning # dump logs that contain warnings
631-
dump-logs: all # dump all logs for local non-dependency packages
633+
dump-logs: none # don't dump the content of any log files
634+
dump-logs: warning # dump the content of log files that are warnings
635+
dump-logs: all # dump all of the content of log files
632636
~~~
633637

638+
At the command line, `--no-dump-logs` is equivalent to `dump-logs: none` and
639+
`--dump-logs` is equivalent to `dump-logs: all`.
640+
634641
### extra-include-dirs
635642

636643
Default: `[]`

0 commit comments

Comments
 (0)