Skip to content

Commit c375c68

Browse files
committed
Re #5566 Further improve online documentation for dump-logs
1 parent c60c016 commit c375c68

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

doc/build_command.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -559,14 +559,16 @@ package is targetted in a multi-package project (for example, using
559559

560560
* **More than one target package:** The build output from GHC (as opposed to
561561
from Stack) for each target package is sent to a log file for that package,
562-
unless an error occurs that prevents that. At the end of the build, the
563-
location of the directory containing the log files is reported. To also output
564-
the contents of the log files to the standard error output stream of the
565-
console at the end of the build, use Stack's `dump-logs` option. For further
562+
unless an error occurs that prevents that. If color in output is in use, there
563+
will be two files, one with extension `.log` without color codes and one with
564+
extension `.log-color` with color codes. At the end of the build, the location
565+
of the directory containing the log files is reported. To also output the
566+
contents of the log files to the standard error output stream of the console
567+
at the end of the build, use Stack's `dump-logs` option. For further
566568
information about that option, see the
567569
[YAML configuration](yaml_configuration.md#dump-logs) documentation. The
568-
default `dump-logs` mode is to output the contents of the log files that are
569-
warnings.
570+
default `dump-logs` mode is to output the contents of any log files that
571+
include GHC warnings.
570572

571573
### `--[no]-open` flag
572574

doc/yaml_configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -696,9 +696,9 @@ The value of the `dump-logs` key controls what, if any, log file content is sent
696696
build. Possible values are:
697697

698698
~~~yaml
699-
dump-logs: none # don't dump the content of any log files
700-
dump-logs: warning # dump the content of log files that are warnings
701-
dump-logs: all # dump all of the content of log files
699+
dump-logs: none # don't dump the content of any log files
700+
dump-logs: warning # dump the content of any log files that include GHC warnings
701+
dump-logs: all # dump the content of all log files
702702
~~~
703703

704704
At the command line, `--no-dump-logs` is equivalent to `dump-logs: none` and

0 commit comments

Comments
 (0)