Skip to content

Commit a638e81

Browse files
committed
Fix typo and formatting problems
1 parent b750631 commit a638e81

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

doc/yaml_configuration.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,7 @@ By default, Stack obtains the dictionary from
660660
[stack-setup-2.yaml](https://github.com/commercialhaskell/stackage-content/raw/master/stack/stack-setup-2.yaml).
661661

662662
The `setup-info` dictionary is constructed in the following order:
663+
663664
1. `setup-info` in the YAML configuration - inline configuration
664665
2. `--setup-info-yaml` command line arguments - URLs or paths. Multiple
665666
locations may be specified.
@@ -687,7 +688,7 @@ supports the following pairs in the format of the `setup-info` field:
687688
|Operating system|I386 arch|X86_64 arch|Other machine architectures |
688689
|----------------|---------|-----------|------------------------------------------------------------|
689690
|Linux |linux32 |linux64 |AArch64: linux-aarch64, Arm: linux-armv7, Sparc: linux-sparc|
690-
|OSX |macos |macos | |
691+
|OSX |macosx |macosx | |
691692
|Windows |windows32|windows64 | |
692693
|FreeBSD |freebsd32|freebsd64 |AArch64: freebsd-aarch64 |
693694
|OpenBSD |openbsd32|openbsd64 | |
@@ -721,9 +722,10 @@ default. Specifying this configuration **does not** prevent the default
721722
from being consulted as a fallback. If, however, you need to **replace** the
722723
default `setup-info` dictionary, use the following:
723724

724-
```yaml
725+
~~~yaml
725726
setup-info-locations: []
726-
```
727+
~~~
728+
727729
### setup-info-locations
728730

729731
(Since 2.3)
@@ -736,15 +738,15 @@ tool - `('Tool', 'Platform', 'Version')` - takes precedence. For example, you
736738
can extend the default tools, with a fallback to the default `setup-info`
737739
location, as follows:
738740

739-
```yaml
741+
~~~yaml
740742
setup-info-locations:
741743
- C:/stack-offline/my-stack-setup.yaml
742744
- relative/inside/my/project/setup-info.yaml
743745
- \\smbShare\stack\my-stack-setup.yaml
744746
- http://stack-mirror.com/stack-setup.yaml
745747
# Fallback to the default location
746748
- https://github.com/commercialhaskell/stackage-content/raw/master/stack/stack-setup-2.yaml
747-
```
749+
~~~
748750

749751
Stack only refers to the default `setup-info` location if no locations are
750752
specified in the `setup-info-locations` configuration or on the command line
@@ -753,15 +755,16 @@ using the `--setup-info-yaml` option.
753755
For example, both of the following will cause `stack setup` not to consult the
754756
default `setup-info` location:
755757

756-
```yaml
758+
~~~yaml
757759
setup-info-locations:
758760
- C:/stack-offline/my-stack-setup.yaml
759-
```
761+
~~~
762+
760763
and
761764

762-
```yaml
765+
~~~yaml
763766
setup-info-locations: []
764-
```
767+
~~~
765768

766769
Relative paths are resolved relative to the `stack.yaml` file (either the one in
767770
the local project or the global `stack.yaml`).
@@ -771,24 +774,27 @@ or 7z). This allows vendoring the tools inside a monorepo (a single respository
771774
storing many projects). For example:
772775

773776
Directory structure:
774-
```
777+
778+
~~~
775779
- src/
776780
- installs/
777781
- my-stack-setup.yaml
778782
- 7z.exe
779783
- 7z.dll
780784
- ghc-9.2.3.tar.xz
781785
- stack.yaml
782-
```
786+
~~~
783787

784788
In the project's `stack.yaml`:
785-
```yaml
789+
790+
~~~yaml
786791
setup-info-locations:
787792
- installs/my-stack-setup.yaml
788-
```
793+
~~~
789794

790795
In `installs/my-stack-setup.yaml`:
791-
```yaml
796+
797+
~~~yaml
792798
sevenzexe-info:
793799
url: "installs/7z.exe"
794800

@@ -799,7 +805,7 @@ ghc:
799805
windows64:
800806
9.2.3:
801807
url: "installs/ghc-9.2.3.tar.xz"
802-
```
808+
~~~
803809

804810
### pvp-bounds
805811

0 commit comments

Comments
 (0)