Skip to content

Commit 507016b

Browse files
committed
Re #1495 Clarify online documentation for skip-msys
1 parent 20f3822 commit 507016b

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

doc/global_flags.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,10 @@ Restrictions: Windows systems only
210210

211211
Default: Disabled
212212

213-
Enables/disables the skipping of installing MSYS2. For further information, see
214-
the documentation for the corresponding non-project specific configuration
213+
Enables/disables the skipping of checking for the Stack-supplied MSYS2 (and
214+
installing that MSYS2, if it is not installed) when Stack is setting up the
215+
environment. For further information, see the documentation for the
216+
corresponding non-project specific configuration
215217
[option](yaml_configuration.md#skip-msys).
216218

217219
## `--snapshot` option

doc/yaml_configuration.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1678,16 +1678,21 @@ Restrictions: Windows systems only
16781678

16791679
Default: `false`
16801680

1681-
Command line equivalent (takes precedence): `--[no-]skip-msys` flag
1681+
Command line equivalent (takes precedence):
1682+
[`--[no-]skip-msys`](global_flags.md#-no-skip-msys-option) flag
16821683

1683-
Skips checking for and installing MSYS2 when stack is Setting up the
1684-
environment. This usually doesn't make sense in project-level configurations,
1685-
just in `config.yaml`.
1684+
Skips checking for the Stack-supplied MSYS2 (and installing that MSYS2, if it is
1685+
not installed) when Stack is setting up the environment.
16861686

16871687
~~~yaml
16881688
skip-msys: true
16891689
~~~
16901690

1691+
!!! note
1692+
1693+
Usually, the use of this option does not make sense in project-level
1694+
configuration and it is used only in global configuration.
1695+
16911696
### snapshot-location-base
16921697

16931698
[:octicons-tag-24: 2.5.1](https://github.com/commercialhaskell/stack/releases/tag/v2.5.1)

0 commit comments

Comments
 (0)