Skip to content

Commit bec107d

Browse files
committed
Merge branch 'stable'
2 parents 34b1da7 + d3ce59c commit bec107d

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

doc/yaml_configuration.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2036,9 +2036,17 @@ The script **must** return an exit code of `0` and the standard output **must**
20362036
be the absolute path to the GHC binary that was installed. Otherwise Stack will
20372037
ignore the script and possibly fall back to its own installation procedure.
20382038

2039-
The script is not run when `system-ghc: true`.
2039+
When `system-ghc: true`, the script is not run. That is because the two
2040+
mechanisms reflect distinct concepts, namely:
20402041

2041-
When `install-ghc: false`, the script is still run, which allows you to ensure
2042+
* `system-ghc: true` causes Stack to search the PATH for a version of GHC; and
2043+
2044+
* `hooks/ghc-install.sh` causes Stack to execute a script that is intended to
2045+
send to standard output a path to a version of GHC. The path in question may
2046+
or may not be in the PATH. The script may also do other things, including
2047+
installation.
2048+
2049+
When `install-ghc: false`, the script is still run. That allows you to ensure
20422050
that only your script will install GHC and Stack won't default to its own
20432051
installation logic, even when the script fails.
20442052

0 commit comments

Comments
 (0)