Merge branch 'stable'

Author: mpilgrem

CONTRIBUTING.md

@@ -605,7 +605,7 @@ The `pedantic` job runs on `ubuntu` only and builds Stack with the
 `--pedantic` flag.
 
 The `unit-tests` job runs on a matrix of operating systems and Stack
-project-level YAML configuration files (`stack.yaml`, by default). It builds and
+project-level configuration files (`stack.yaml`, by default). It builds and
 tests Stack with the following flags: `--haddock --no-haddock-deps`.
 
 Its approach to creating a cache depends on the operating system. Its 'Cache

doc/commands/build_command.md

@@ -739,26 +739,27 @@ The effect of `--fast` can be overriden with Stack's
     options are used during the configure step of the Cabal build process; see
     Stack's
     [`configure-options`](../configure/yaml/non-project.md#configure-options)
-    YAML configuration option.
+    non-project specific configuration option.
 
 ### `--ghc-options` option
 
 GHC command line options can be specified for a package in its Cabal file
 (including one created from a `package.yaml` file). This option augments and, if
 applicable (see below), overrides any such GHC command line options and those
-specified in Stack's YAML configuration files - see the
-[`ghc-options`](../configure/yaml/non-project.md#ghc-options) configuration
-option.
+specified in Stack's configuration files - see the
+[`ghc-options`](../configure/yaml/non-project.md#ghc-options) non-project
+specific configuration option.
 
 `stack build --ghc-options <ghc_options>` passes the specified command line
 options to GHC, depending on Stack's
-[`apply-ghc-options`](../configure/yaml/non-project.md#apply-ghc-options) YAML
-configuration option. This option can be specified multiple times.
+[`apply-ghc-options`](../configure/yaml/non-project.md#apply-ghc-options)
+non-project specific configuration option. This option can be specified multiple
+times.
 
 GHC's command line options are _order-dependent_ and evaluated from left to
 right. Later options can override the effect of earlier ones. Any GHC command
 line options for a package specified at Stack's command line are applied after
-those specified in Stack's YAML configuration files.
+those specified in Stack's configuration files.
 
 ### `--[no-]library-profiling` flag
 
@@ -972,9 +973,9 @@ package is targetted in a multi-package project (for example, using
   contents of the log files to the standard error output stream of the console
   at the end of the build, use Stack's `dump-logs` option. For further
   information about that option, see the
-  [YAML configuration](../configure/yaml/non-project.md#dump-logs)
-  documentation. The default `dump-logs` mode is to output the contents of any
-  log files that include GHC warnings.
+  [`dump-logs](../configure/yaml/non-project.md#dump-logs) non-project
+  specific configuration option documentation. The default `dump-logs` mode is
+  to output the contents of any log files that include GHC warnings.
 
 ### `--[no]-open` flag
 
@@ -1028,8 +1029,7 @@ All the following examples assume that:
     consequently, the project-level configuration will be determined by a
     `stack.yaml` file in the `global-project` directory in the
     [Stack root](../topics/stack_root.md) (for further information, see the
-    [YAML configuration](../configure/yaml/yaml_configuration.md)
-    documentation); and
+    [configuration](../configure/yaml/index.md) documentation); and
 
 *   if `stack build` is commanded in a project directory, there is a
     `stack.yaml` file in that directory.

doc/commands/config_command.md

@@ -7,7 +7,7 @@ stack config COMMAND
 
 Available commands:
   env                      Print environment variables for use in a shell
-  set                      Sets a key in YAML configuration file to value
+  set                      Sets a key in configuration file to value
 ~~~
 
 The `stack config` commands provide assistance with accessing or modifying
@@ -58,8 +58,8 @@ Available commands:
                            GHC installation.
 ~~~
 
-The `stack config set` commands allow the values of keys in YAML configuration
-files to be set. See `stack config set` for the available keys.
+The `stack config set` commands allow the values of keys in configuration files
+to be set. See `stack config set` for the available keys.
 
 !!! note
 
@@ -73,10 +73,11 @@ stack config set install-ghc [--global] true|false
 ~~~
 
 `stack config set install-ghc true` or `false` sets the
-[`install-ghc`](yaml_configuration.md#install-ghc) key in a YAML configuration
-file, accordingly. By default, the project-level configuration file
-(`stack.yaml`, by default) is altered. The `--global` flag specifies the
-user-specific global configuration file (`config.yaml`).
+[`install-ghc`](../configure/yaml/non-project.md#install-ghc) non-project
+specific configuration option in a configuration file, accordingly. By default,
+the project-level configuration file (`stack.yaml`, by default) is altered. The
+`--global` flag specifies the user-specific global configuration file
+(`config.yaml`).
 
 ## The `stack config set package-index download-prefix` command
 
@@ -88,10 +89,11 @@ stack config set package-index download-prefix [--global] [URL]
 
 `stack config set package-index download-prefix <url>` sets the
 `download-prefix` key of the
-[`package-index`](yaml_configuration.md#package-index) key in a YAML
-configuration file, accordingly. By default, the project-level configuration
-file (`stack.yaml`, by default) is altered. The `--global` flag specifies the
-user-specific global configuration file (`config.yaml`).
+[`package-index`](../configure/yaml/non-project.md#package-index) non-project
+specific configuration option in a configuration file, accordingly. By default,
+the project-level configuration file (`stack.yaml`, by default) is  altered. The
+`--global` flag specifies the user-specific global configuration  file
+(`config.yaml`).
 
 ## The `stack config set recommend-stack-upgrade` command
 
@@ -100,10 +102,11 @@ stack config set recommend-stack-upgrade [--project] true|false
 ~~~
 
 `stack config set recommend-stack-upgrade true` or `false` sets the
-[`recommend-stack-upgrade`](yaml_configuration.md#recommend-stack-upgrade) key
-in a YAML configuration file, accordingly. By default, the user-specific global
-configuration file (`config.yaml`) is altered. The `--project` flag specifies
-the project-level configuration file (`stack.yaml`, by default).
+[`recommend-stack-upgrade`](../configure/yaml/non-project.md#recommend-stack-upgrade)
+non-project specific configuration option in a configuration file, accordingly.
+By default, the user-specific global configuration file (`config.yaml`) is
+altered. The `--project` flag specifies the project-level configuration file
+(`stack.yaml`, by default).
 
 ## The `stack config set resolver` command
 
@@ -140,7 +143,8 @@ stack config set system-ghc [--global] true|false
 ~~~
 
 `stack config set system-ghc true` or `false` sets the
-[`system-ghc`](yaml_configuration.md#system-ghc) key in a YAML configuration
-file, accordingly. By default, the project-level configuration file
-(`stack.yaml`, by default) is altered. The `--global` flag specifies the
-user-specific global configuration file (`config.yaml`).
+[`system-ghc`](../configure/yaml/non-project.md#system-ghc) non-project
+specific configuration option in a configuration file, accordingly. By default,
+the project-level configuration file (`stack.yaml`, by default) is altered. The
+`--global` flag specifies the user-specific global configuration file
+(`config.yaml`).

doc/commands/init_command.md

@@ -6,7 +6,7 @@
 stack init [DIR(S)] [--omit-packages] [--force] [--ignore-subdirs]
 ~~~
 
-`stack init` initialises Stack's default project-level YAML configuration file
+`stack init` initialises Stack's default project-level configuration file
 (`stack.yaml`) for an existing project, based on the Cabal file or
 `package.yaml` file for each of its packages.
 

doc/commands/ls_command.md

@@ -232,8 +232,9 @@ example of the applied style. The latter can be disabled with flags `--no-sgr`
 and `--no-example`.
 
 The flag `--basic` specifies a more basic report, in the format that is accepted
-by Stack's command line option `--stack-colors` and the YAML configuration key
-`stack-colors`.
+by Stack's command line option `--stack-colors` and the
+[`stack-colors`](../configure/yaml/non-project.md#stack-colors) non-project
+specific configuration option.
 
 ## The `stack ls tools` command
 

doc/commands/path_command.md

@@ -22,12 +22,12 @@ Pass the following flags for information about specific files or locations:
 |--compiler-bin         |The directory containing the GHC executable.          |
 |--compiler-exe         |The GHC executable.                                   |
 |--compiler-tools-bin   |The directory containing binaries specific to a particular compiler.|
-|--config-location      |Stack's project-level YAML configuration file (`stack.yaml`, by default).|
+|--config-location      |Stack's project-level configuration file (`stack.yaml`, by default).|
 |--dist-dir             |The dist work directory, relative to the package directory.|
 |--extra-include-dirs   |Extra include directories.                            |
 |--extra-library-dirs   |Extra library directories.                            |
 |--ghc-package-path     |The `GHC_PACKAGE_PATH` environment variable.          |
-|--global-config        |Stack's user-specific global YAML configuration file (`config.yaml`).|
+|--global-config        |Stack's user-specific global configuration file (`config.yaml`).|
 |--global-pkg-db        |The global package database.                          |
 |--local-bin            |The directory in which Stack installs executables.    |
 |--local-doc-root       |The root directory for local project documentation.   |

doc/commands/sdist_command.md

@@ -27,7 +27,8 @@ available modes for use with Cabal file revisions are `lower-revision`,
 `upper-revision` and `both-revision`.
 
 For futher information, see the
-[YAML configuration](../configure/yaml/non-project.md#pvp-bounds) documentation.
+[`pvp-bounds`](../configure/yaml/non-project.md#pvp-bounds) non-project specific
+configuration option documentation.
 
 ## `--tar-dir` option
 

doc/commands/setup_command.md

@@ -23,9 +23,9 @@ By default:
 Pass the option `--ghc-bindist <url>` to specify the URL of the GHC to be
 downloaded and installed. This option requires the use of the `--ghc-variant`
 option specifying a custom GHC variant. For further information about the
-`--ghc-variant` option, see the see the
-[YAML configuration](../configure/yaml/non-project.md#ghc-variant)
-documentation.
+`--ghc-variant` option, see the
+[`ghc-variant`](../configure/yaml/non-project.md#ghc-variant) non-project
+specific configuration option documentation.
 
 If Stack is configured not to install GHC (`install-ghc: false` or passing the
 `--no-install-ghc` flag) then `stack setup` will warn that the flag and the

doc/commands/upload_command.md

@@ -57,7 +57,8 @@ available modes for use with Cabal file revisions are `lower-revision`,
 `upper-revision` and `both-revision`.
 
 For futher information, see the
-[YAML configuration](../configure/yaml/non-project.md#pvp-bounds) documentation.
+[`pvp-bounds`](../configure/yaml/non-project.md#pvp-bounds) non-project
+specific configuration option documentation.
 
 The `--tar-dir <path_to_directory>` option determines whether the package
 archive should be copied to the specified directory.

doc/configure/environment_variables.md

@@ -88,25 +88,24 @@ sequences for color to its output.
 ## `STACK_CONFIG`
 
 Related command: all commands that make use of Stack's
-[global YAML configuration files](yaml/yaml_configuration.md) (`config.yaml`).
+[global configuration](yaml/index.md) files (`config.yaml`).
 
 The environment variable `STACK_CONFIG` can be used to specify an absolute path
-to the user-specific global YAML configuration file, overriding the default.
+to the user-specific global configuration file, overriding the default.
 
 ## `STACK_GLOBAL_CONFIG`
 
 Related command: all commands that make use of Stack's
-[global YAML configuration files](yaml/yaml_configuration.md) (`config.yaml`).
+[global configuration](yaml/index.md) files (`config.yaml`).
 
 The environment variable `STACK_GLOBAL_CONFIG` can be used to specify an
-absolute path to the system-wide global YAML configuration file, overriding the
+absolute path to the system-wide global configuration file, overriding the
 default.
 
 ## `STACK_ROOT`
 
 Related command: all commands that make use of Stack's
-[user-specific global YAML configuration file](yaml/yaml_configuration.md)
-(`config.yaml`).
+[user-specific global configuration](yaml/index.md) file (`config.yaml`).
 
 Overridden by: Stack's global
 [`--stack-root`](global_flags.md#-stack-root-option) option.
@@ -131,8 +130,7 @@ the root directory of the project or package. The relative path cannot include a
 ## `STACK_XDG`
 
 Related command: all commands that make use of Stack's
-[user-specific global YAML configuration file](yaml/yaml_configuration.md)
-(`config.yaml`).
+[user-specific global configuration](yaml/index.md) file (`config.yaml`).
 
 Overridden by: the use of Stack's `STACK_ROOT` environment variable, or the use
 of Stack's global
@@ -145,10 +143,10 @@ set to any non-empty value.
 ## `STACK_YAML`
 
 Related command: all commands that make use of Stack's
-[project-level YAML configuration file](yaml/yaml_configuration.md).
+[project-level configuration](yaml/index.md).
 
 Overridden by: Stack's global
 [`--stack-yaml`](global_flags.md#-stack-yaml-option) option.
 
 The environment variable `STACK_YAML` can be used to specify Stack's
-project-level YAML configuration file.
+project-level configuration file.