Skip to content

Commit 96199bb

Browse files
committed
Warn about corrupt *.conf files for GHC boot packages on Windows
1 parent e6c190f commit 96199bb

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/build_command.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,19 @@ sets this flag.
230230
Stack applies Haddock's `--gen-contents` and `--gen-index` flags to generate a
231231
single HTML contents and index for multiple sets of Haddock documentation.
232232

233+
!!! warning
234+
235+
On Windows, the values for the `haddock-interfaces` and `haddock-html` keys
236+
in the `*.conf` files for boot packages provided with certain versions of
237+
GHC (in its `lib\package.conf.d` directory) can be corrupt and refer to
238+
non-existent files and directories. For example, in the case of GHC 9.0.1
239+
to GHC 9.8.1 the references are to
240+
`${pkgroot}/../../docs/html/libraries/...` or
241+
`${pkgroot}/../../doc/html/libraries/...` instead of
242+
`${pkgroot}/../docs/html/libraries/...` or
243+
`${pkgroot}/../doc/html/libraries/...`. Until those values are corrected,
244+
Haddock documentation will be missing links to what those packages expose.
245+
233246
### `--haddock-arguments` option
234247

235248
`stack haddock --haddock-arguments <haddock_argument(s)>` passes the specified

0 commit comments

Comments
 (0)