Skip to content

Commit 756d5c9

Browse files
committed
Fix #5722 Document --keep-tmp-files option in guide
1 parent b2d35a6 commit 756d5c9

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/build_command.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ dependencies. See the
117117
[build command section of the user guide](GUIDE.md#the-build-command) for
118118
details of how these dependencies get specified.
119119

120-
In addition to specifying targets, you can also control what gets built with the
121-
following flags:
120+
In addition to specifying targets, you can also control what gets built, or
121+
retained, with the following flags:
122122

123123
* `--haddock`, to build documentation. This may cause a lot of packages to get
124124
re-built, so that the documentation links work.
@@ -140,13 +140,17 @@ following flags:
140140
* `--keep-going`, to continue building packages even after some build step
141141
fails. The packages which depend upon the failed build won't get built.
142142

143+
* `--keep-tmp-files`, to keep intermediate files and build directories that
144+
would otherwise be considered temporary and deleted. It may be useful to
145+
inspect these, if a build fails. By default, they are not kept.
146+
143147
* `--skip`, to skip building components of a local package. It allows
144148
you to skip test suites and benchmark without specifying other components
145149
(e.g. `stack test --skip long-test-suite` will run the tests without the
146150
`long-test-suite` test suite). Be aware that skipping executables won't work
147-
the first time the package is built due to
151+
the first time the package is built due to
148152
[an issue in cabal](https://github.com/commercialhaskell/stack/issues/3229).
149-
This option can be specified multiple times to skip multiple components.
153+
This option can be specified multiple times to skip multiple components.
150154

151155
## Flags
152156

0 commit comments

Comments
 (0)