Skip to content

Commit 36272e8

Browse files
committed
Improve online MSYS2 documentation
1 parent 0157392 commit 36272e8

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

doc/developing_on_windows.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,16 @@ environment too by executing all programs through
1414
`stack exec -- <program_name>`.
1515

1616
Executables and libraries can be installed with the MSYS2 package manager
17-
`pacman`. All tools can be found in the
18-
[package list](https://github.com/msys2/msys2/wiki/Packages). A [list of
19-
commands](https://github.com/msys2/msys2/wiki/Using-packages) that work with
20-
`pacman` is also available. Just remember that `pacman` &mdash; like all other
21-
tools &mdash; should be started with `stack exec -- pacman`.
17+
`pacman`. All tools can be found in the [index](https://packages.msys2.org) to
18+
MSYS2 packages. A [guide](https://www.msys2.org/docs/package-management/) to
19+
package management with `pacman` is also available. `pacman` &mdash; like all
20+
other tools in the Stack environment &mdash; should be started with
21+
`stack exec -- pacman`. Help about `pacman` commands (operations) can be
22+
obtained by `stack exec -- pacman --help`. Help about a specific `pacman`
23+
operation can be obtained by using `--help` (or `-h`) with an operation. For
24+
example, help about the operation `--sync` (or `-S`) can be obtained with
25+
`stack exec -- pacman --sync --help` or, equivalently,
26+
`stack exec -- pacman -Sh`.
2227

2328
Command `stack path --bin-path` to see the PATH in the Stack environment. On
2429
Windows, it includes the `\mingw64\bin`, `\usr\bin` and `\usr\local\bin`
@@ -27,13 +32,14 @@ directories of the Stack-supplied MSYS2. If your executable depends on files
2732
it outside of the Stack environment, you will need to ensure copies of those
2833
files are on the PATH.
2934

35+
## Updating the Stack-supplied MSYS2 ##
36+
3037
The Stack-supplied MSYS2 can itself be updated with the Stack-supplied `pacman`.
31-
See the MSYS2 guide
32-
['III. Updating packages'](https://www.msys2.org/wiki/MSYS2-installation/). If
38+
See the MSYS2 guide [Updating MSYS2](https://www.msys2.org/docs/updating/). If
3339
the Stack-supplied `pacman` has a version that is 5.0.1.6403 or greater (see
3440
`stack exec -- pacman --version`) then the command to update is simply:
3541

36-
stack exec -- pacman -Syuu
42+
stack exec -- pacman -Suy
3743

3844
This command may need to be run more than once, until everything is reported by
3945
`pacman` as 'up to date' and 'nothing to do'.

0 commit comments

Comments
 (0)