@@ -118,9 +118,11 @@ using the `stack setup` command.
118
118
You'll get intermediate download percentage statistics while the download is
119
119
occurring. This command may take some time, depending on download speeds.
120
120
121
- __ NOTE__ : GHC will be installed to your Stack programs directory, so calling
122
- ` ghc ` on the command line won't work. See the ` stack exec ` , ` stack ghc ` , and
123
- ` stack runghc ` commands below for more information.
121
+ !!! note
122
+
123
+ GHC will be installed to your Stack programs directory, so calling `ghc` on
124
+ the command line won't work. See the `stack exec`, `stack ghc`, and
125
+ `stack runghc` commands below for more information.
124
126
125
127
Once a version of GHC is installed, Stack will then build your project.
126
128
@@ -323,10 +325,11 @@ the remainder of this guide will cover more advanced `build` functions and
323
325
features, such as building test and Haddocks at the same time, or constantly
324
326
rebuilding blocking on file changes.
325
327
326
- * On a philosophical note:* Running the ` build ` command twice with the same
327
- options and arguments should generally be a no-op (besides things like rerunning
328
- test suites), and should, in general, produce a reproducible result between
329
- different runs.
328
+ !!! note
329
+
330
+ Using the `build` command twice with the same options and arguments should
331
+ generally do nothing (besides things like rerunning test suites), and
332
+ should, in general, produce a reproducible result between different runs.
330
333
331
334
## Adding dependencies
332
335
@@ -610,8 +613,10 @@ stack init
610
613
Assuming it finds a match, it will write your ` stack.yaml ` file, and everything
611
614
will work.
612
615
613
- (Note: ` yackage ` does not currently support Hpack, but you can also use
614
- ` hpack-convert ` should you need to generate a ` package.yaml ` .)
616
+ !!! note
617
+
618
+ The `yackage` package does not currently support Hpack, but you can also use
619
+ `hpack-convert` should you need to generate a `package.yaml` file.
615
620
616
621
#### Excluded Packages
617
622
@@ -984,7 +989,7 @@ Completed 2 action(s).
984
989
~~~
985
990
986
991
We first cleaned our project to clear old results so we know exactly what Stack
987
- is trying to do. Note that is says it is building all executables for
992
+ is trying to do. Note that it says it is building all executables for
988
993
` helloworld ` once, and that after a successful build of all of them, only
989
994
specified executables will be rebuilt. If we change the source code of
990
995
` test/Spec.hs ` , say to:
@@ -1039,9 +1044,11 @@ You can use the `--no-run-tests` and `--no-run-benchmarks` flags to disable
1039
1044
running of these components. You can also use ` --no-rerun-tests ` to prevent
1040
1045
running a test suite which has already passed and has not changed.
1041
1046
1042
- NOTE: Stack doesn't build or run test suites and benchmarks for non-local
1043
- packages. This is done so that running a command like ` stack test ` doesn't need
1044
- to run 200 test suites!
1047
+ !!! note
1048
+
1049
+ Stack doesn't build or run test suites and benchmarks for non-local
1050
+ packages. This is done so that a command like `stack test` doesn't need to
1051
+ run 200 test suites!
1045
1052
1046
1053
## Multi-package projects
1047
1054
@@ -1097,10 +1104,12 @@ In addition to local directories, you can also refer to packages available in a
1097
1104
Git repository or in a tarball over HTTP/HTTPS. This can be useful for using a
1098
1105
modified version of a dependency that hasn't yet been released upstream.
1099
1106
1100
- Please note that when adding upstream packages directly to your project it is
1101
- important to distinguish _local packages_ from the upstream _dependency
1102
- packages_. Otherwise you may have trouble running `stack ghci`. See
1103
- [stack.yaml documentation](yaml_configuration.md#packages) for more details.
1107
+ !!! note
1108
+
1109
+ When adding upstream packages directly to your project it is important to
1110
+ distinguish _local packages_ from the upstream _dependency packages_.
1111
+ Otherwise you may have trouble running `stack ghci`. See
1112
+ [stack.yaml documentation](yaml_configuration.md#packages) for more details.
1104
1113
1105
1114
# # Flags and GHC options
1106
1115
@@ -1197,10 +1206,12 @@ packages, you can add them to your `stack.yaml` file. See the
1197
1206
[ documentation section on ghc-options] ( yaml_configuration.md#ghc-options )
1198
1207
for more information.
1199
1208
1200
- ## The ` stack path ` command
1209
+ !!! note
1201
1210
1202
- NOTE: That's it, the heavy content of this guide is done! Everything from here
1203
- on out is simple explanations of commands. Congratulations!
1211
+ That's it, the heavy content of this guide is done! Everything from here on
1212
+ out is simple explanations of commands. Congratulations!
1213
+
1214
+ ## The ` stack path ` command
1204
1215
1205
1216
Generally, you don't need to worry about where Stack stores various files. But
1206
1217
some people like to know this stuff. That's when the ` stack path ` command is
@@ -1294,6 +1305,11 @@ follows the Unix convention of `--` to separate these. For example, command:
1294
1305
1295
1306
~~~ text
1296
1307
stack exec --package stm -- echo I installed the stm package via --package stm
1308
+ ~~~
1309
+
1310
+ yields ouput like:
1311
+
1312
+ ~~~ text
1297
1313
Run from outside a project, using implicit global project config
1298
1314
Using latest snapshot resolver: lts-18.3
1299
1315
Writing global (non-project-specific) config file to: /home/michael/.stack/global/stack.yaml
0 commit comments