Merge branch 'stable'

Author: mpilgrem

.github/ISSUE_TEMPLATE/bug_report.md

@@ -5,8 +5,9 @@ about: Report a bug in Stack
 
 Please follow the steps below for reporting a bug:
 
-Make sure that you are using the latest release (currently stack-2.7.5).
-See the [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade) to upgrade.
+Make sure that you are using the latest release (currently stack-2.7.5). See the
+[upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade)
+to upgrade.
 
 Please use the following schema for your bug report:
 
@@ -31,20 +32,21 @@ What you expected to see and happen.
 
 What actually happened.
 
-If you suspect that a stack command misbehaved, please include the output of that command in `--verbose` mode.
-If the output is larger than a page please paste the output in a [Gist](https://gist.github.com/).
+If you suspect that a Stack command misbehaved, please include the output of
+that command in `--verbose` mode. If the output is larger than a page please
+paste the output in a [Gist](https://gist.github.com/).
 
-```
-$ stack <your command here> <args> --verbose
+~~~text
+stack <your command here> <args> --verbose
 <output>
-```
+~~~
 
 ### Stack version
 
-```
-$ stack --version
+~~~text
+stack --version
 Version 1.9.1, Git revision f9d0042c141660e1d38f797e1d426be4a99b2a3c (6168 commits) x86_64 hpack-0.31.0
-```
+~~~
 
 ### Method of installation
 

.github/ISSUE_TEMPLATE/question.md

@@ -14,10 +14,10 @@ See the [upgrade instructions](http://docs.haskellstack.org/en/stable/install_an
 
 ### Stack version
 
-```
-$ stack --version
+~~~text
+stack --version
 Version 1.9.1, Git revision f9d0042c141660e1d38f797e1d426be4a99b2a3c (6168 commits) x86_64 hpack-0.31.0
-```
+~~~
 
 ### Method of installation
 

CONTRIBUTING.md

@@ -220,13 +220,17 @@ You can install HLint with Stack. You might want to install it in the global
 project in case you run into dependency conflicts. HLint can report hints in
 your favourite text editor. Refer to the HLint repository for more details.
 
-To install:
+To install, command:
 
-    stack install hlint
+~~~text
+stack install hlint
+~~~
 
-Once installed, you can check your changes with:
+Once installed, you can check your changes with command:
 
-    $ ./etc/scripts/hlint.sh
+~~~text
+stack exec -- sh ./etc/scripts/hlint.sh
+~~~
 
 ## Testing
 
@@ -236,11 +240,11 @@ be found in the
 folder and unit tests, in the
 [src/test](https://github.com/commercialhaskell/stack/tree/master/src/test)
 folder. Tests are written using the [Hspec](https://hspec.github.io/) framework.
-In order to run the full test suite, you can simply do:
+In order to run the full test suite, you can simply command:
 
-```bash
-$ stack test
-```
+~~~text
+stack test
+~~~
 
 The `--file-watch` is a very useful option to get quick feedback. However,
 running the entire test suite after each file change will slow you down. You'll
@@ -250,59 +254,59 @@ description of this follows below.
 
 ### Working with Unit Tests
 
-If you would like to run the unit tests on their own, you can:
+If you would like to run the unit tests on their own, you can command:
 
-```bash
-$ stack test stack:stack-test
-```
+~~~text
+stack test stack:stack-test
+~~~
 
-Running an individual module works like this:
+Running an individual module works with a command like this:
 
-```bash
-$ stack test stack:stack-test --ta "-m <PATTERN>"
-```
+~~~text
+stack test stack:stack-test --ta "-m <PATTERN>"
+~~~
 
 Where `<PATTERN>` is the name of the module without `Spec.hs`.
 
-You may also load tests into GHCi and run them with:
+You may also load tests into GHCi and run them with these command:
 
-```bash
-$ stack ghci stack:stack-test --only-main
+~~~text
+stack ghci stack:stack-test --only-main
 # GHCi starting up output ...
 > :main -m "<PATTERN>"
-```
+~~~
 
 Where again, `<PATTERN>` is the name of the module without `Spec.hs`.
 
 ### Working with Integration Tests
 
-Running the integration tests is a little involved, you'll need to:
+Running the integration tests is a little involved, you'll need to command:
 
-```bash
-$ stack build --flag stack:integration-tests stack --exec stack-integration-test
-```
+~~~text
+stack build --flag stack:integration-tests stack --exec stack-integration-test
+~~~
 
-Running an individual module works like this:
+Running an individual module works with a command like this:
 
-```bash
-$ stack build --flag stack:integration-tests stack --exec "stack-integration-test -m <PATTERN>"
-```
+~~~text
+stack build --flag stack:integration-tests stack --exec "stack-integration-test -m <PATTERN>"
+~~~
 
 Where `<PATTERN>` is the name of the folder listed in the
 [test/integration/tests/](https://github.com/commercialhaskell/stack/tree/master/test/integration/tests)
-folder.
+directory.
 
-You may also achieve this through GHCi with:
+You may also achieve this through GHCi with tihs command:
 
-```bash
-$ stack ghci stack:stack-integration-test
+~~~text
+stack ghci stack:stack-integration-test
 # GHCi starting up output ...
 > :main -m "<PATTERN>"
-```
+~~~
 
 Where again, `<PATTERN>` is the name of the folder listed in the
 [test/integration/tests/](https://github.com/commercialhaskell/stack/tree/master/test/integration/tests)
-folder.
+directory.
 
 ## Continuous integration (CI)
 

ChangeLog.md

@@ -1997,7 +1997,8 @@ Other enhancements:
   [#1306](https://github.com/commercialhaskell/stack/issues/1306)
 * Retry when downloading snapshots and package indices
 * Many build options are configurable now in `stack.yaml`:
-```
+
+  ~~~yaml
   build:
     library-profiling: true
     executable-profiling: true
@@ -2019,7 +2020,8 @@ Other enhancements:
       no-run-benchmarks: true
     reconfigure: true
     cabal-verbose: true
-```
+  ~~~
+
 * A number of URLs are now configurable, useful for firewalls. See
   [#1794](https://github.com/commercialhaskell/stack/issues/1884).
 * Suggest causes when executables are missing.