From 876380e5d9bae9661e938328f1fd842c77e50662 Mon Sep 17 00:00:00 2001 From: Mike Pilgrem Date: Sun, 24 Sep 2023 00:37:01 +0100 Subject: [PATCH] Minor improvements to online documentation --- doc/yaml_configuration.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/doc/yaml_configuration.md b/doc/yaml_configuration.md index 4739b1ee90..8f223ae64f 100644 --- a/doc/yaml_configuration.md +++ b/doc/yaml_configuration.md @@ -1278,29 +1278,26 @@ issues for Stackage maintenance. [:octicons-tag-24: 2.1.1](https://github.com/commercialhaskell/stack/releases/tag/v2.1.1) +Default: `true` + When Stack notices that a new version of Stack is available, should it notify the user? -~~~yaml -recommend-stack-upgrade: true -~~~ - ### rebuild-ghc-options [:octicons-tag-24: 0.1.6.0](https://github.com/commercialhaskell/stack/releases/tag/v0.1.6.0) Default: `false` -Should we rebuild a package when its GHC options change? Before Stack 0.1.6, -this was a non-configurable `true`. However, in most cases, the flag is used to -affect optimization levels and warning behavior, for which GHC itself doesn't -actually recompile the modules anyway. Therefore, the new behavior is to not -recompile on an options change, but this behavior can be changed back with the -following: +Should Stack rebuild a package when its GHC options change? -~~~yaml -rebuild-ghc-options: true -~~~ +The default value reflects that, in most cases, GHC options are used to affect +optimization levels and warning behavior, for which GHC does not recompile the +modules. + +!!! note + + Before Stack 0.1.6.0, Stack rebuilt a package when its GHC options changed. ### require-stack-version