From 79cecd9479b624e5ea88ee5de85f2a0d586127c2 Mon Sep 17 00:00:00 2001 From: Michael Snoyman Date: Wed, 22 Nov 2017 10:38:42 +0200 Subject: [PATCH] Add warnings to docs/release notes about pvp-bounds #3550 --- ChangeLog.md | 3 +++ doc/yaml_configuration.md | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/ChangeLog.md b/ChangeLog.md index 40361c1983..0394a4551e 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -45,6 +45,9 @@ Behavior changes: * Stack will ask before saving hackage credentials to file. This new prompt can be avoided by using the `save-hackage-creds` setting. Please see [#2159](https://github.com/commercialhaskell/stack/issues/2159). +* The `pvp-bounds` feature is no longer fully functional, due to some + issues with the Cabal library's printer. See + [#3550](https://github.com/commercialhaskell/stack/issues/3550). Other enhancements: diff --git a/doc/yaml_configuration.md b/doc/yaml_configuration.md index a25c358dce..b543e3d070 100644 --- a/doc/yaml_configuration.md +++ b/doc/yaml_configuration.md @@ -619,6 +619,13 @@ setup-info: "https://raw.githubusercontent.com/fpco/stackage-content/master/stac (Since 0.1.5) +__NOTE__ As of Stack 1.6.0, this feature does not reliably work, due +to issues with the Cabal library's printer. Stack will generate a +warning when a lossy conversion occurs, in which case you may need to +disable this setting. See +[#3550](https://github.com/commercialhaskell/stack/issues/3550) for +more information. + When using the `sdist` and `upload` commands, this setting determines whether the cabal file's dependencies should be modified to reflect PVP lower and upper bounds. Values are `none` (unchanged), `upper` (add upper bounds), `lower` (add