Skip to content

Commit 7f9f220

Browse files
committed
Document symlink creation restriction on Windows
1 parent ca76ced commit 7f9f220

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/topics/GHC_from_source.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
Stack supports building the GHC compiler from source, using
1010
[Hadrian](https://gitlab.haskell.org/ghc/ghc/blob/master/hadrian/README.md) (the
11-
build system for GHC). The GHC version to build and to use is defined by a a Git
12-
commit ID and a Hadrian "flavour", with the following syntax in a YAML
11+
build system for GHC). The GHC version to be built and used is defined by a
12+
Git commit ID and a Hadrian "flavour", with the following syntax in a YAML
1313
configuration file:
1414

1515
~~~yaml
@@ -40,6 +40,12 @@ enable any known workaround to make older compilers work.
4040
Building the compiler can take a very long time (more than one hour). For faster
4141
build times, use Hadrian flavours that disable documentation generation.
4242

43+
!!! note
44+
45+
The building of the compiler can require the creation of symbolic links
46+
(symlinks). On Windows, symlinks can only be created by processes with
47+
Administrator privileges unless Windows' Developer Mode has been set.
48+
4349
### Bootstrap compiler
4450

4551
Building GHC from source requires a working GHC (known as the bootstrap

0 commit comments

Comments
 (0)