Skip to content

Commit 14e1874

Browse files
committed
Re #6457 Add MINGW64 environment of MSYS2 to the online docs
1 parent e789e34 commit 14e1874

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

doc/developing_on_windows.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
# Developing on Windows #
44

55
On Windows, Stack comes with an installation of [MSYS2](https://www.msys2.org/).
6-
MSYS2 will be used by Stack to provide a Unix-like shell and environment for
7-
Stack. This may be necessary for installing some Haskell packages, such as those
8-
which use `configure` scripts, or if your project needs some additional tools
9-
during the build phase.
6+
The MINGW64 (MINGW32 on 32-bit Windows) environment of MSYS2 will be used by
7+
Stack to provide a Unix-like shell and environment for Stack. This may be
8+
necessary for installing some Haskell packages, such as those which use
9+
`configure` scripts, or if your project needs some additional tools during the
10+
build phase.
1011

1112
No matter which terminal software you choose (Windows Terminal, Console Windows
1213
Host, Command Prompt, PowerShell, Git bash or any other) you can use this
@@ -26,11 +27,18 @@ example, help about the operation `--sync` (or `-S`) can be obtained with
2627
`stack exec -- pacman -Sh`.
2728

2829
Command `stack path --bin-path` to see the PATH in the Stack environment. On
29-
Windows, it includes the `\mingw64\bin`, `\usr\bin` and `\usr\local\bin`
30-
directories of the Stack-supplied MSYS2. If your executable depends on files
31-
(for example, dynamic-link libraries) in those directories and you want ro run
32-
it outside of the Stack environment, you will need to ensure copies of those
33-
files are on the PATH.
30+
Windows, it includes the `\mingw64\bin` (`\mingw32\bin` on 32-bit Windows),
31+
`\usr\bin` and `\usr\local\bin` directories of the Stack-supplied MSYS2. If your
32+
executable depends on files (for example, dynamic-link libraries) in those
33+
directories and you want to run it outside of the Stack environment, you will
34+
need to ensure copies of those files are on the PATH.
35+
36+
Command `stack path --extra-include-dirs` and `stack path --extra-library-dirs`
37+
to see the extra directories searched for C header files or system libraries
38+
files in the Stack environment. On Windows, it includes the `\mingw64\include`
39+
(`mingw32\include` on 32-bit Windows) (include) and the `\mingw64\lib` and
40+
`\mingw64\bin` directories (`mingw32\lib` and `mingw32\bin` on 32-bit Windows)
41+
(library) of the Stack-supplied MSYS2.
3442

3543
## Updating the Stack-supplied MSYS2 ##
3644

doc/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Windows is not able to find the necessary C++ libraries from the standard
371371
prompt because they're not in the PATH environment variable. `stack exec` works
372372
because it's modifying PATH to include extra things.
373373

374-
Those libraries are shipped with GHC (and, theoretically in some cases, MSYS).
374+
Those libraries are shipped with GHC (and, theoretically in some cases, MSYS2).
375375
The easiest way to find them is `stack exec which`. For example, command:
376376

377377
~~~text

0 commit comments

Comments
 (0)