commercialhaskell · snoyberg · Aug 26, 2018 · Jul 16, 2018 · Jul 16, 2018 · Jul 16, 2018
diff --git a/.gitignore b/.gitignore
@@ -27,4 +27,3 @@ tags
 /etc/scripts/stack-scripts.cabal
 .hspec-failures
 better-cache/
-subs/
diff --git a/.hlint.yaml b/.hlint.yaml
@@ -60,7 +60,6 @@
 - error: {lhs: "Network.HTTP.Client.parseUrlThrow", rhs: "Network.HTTP.StackClient.parseUrlThrow"}
 - error: {lhs: "Network.HTTP.Client.path", rhs: "Network.HTTP.StackClient.path"}
 - error: {lhs: "Network.HTTP.Client.responseHeaders", rhs: "Network.HTTP.StackClient.responseHeaders"}
-- error: {lhs: "Network.HTTP.Client.withResponse", rhs: "Network.HTTP.StackClient.withResponseByManager"}
 - error: {lhs: "Network.HTTP.Conduit.requestHeaders", rhs: "Network.HTTP.StackClient.requestHeaders"}
 - error: {lhs: "Network.HTTP.Simple.HttpException", rhs: "Network.HTTP.StackClient.HttpException"}
 - error: {lhs: "Network.HTTP.Simple.addRequestHeader", rhs: "Network.HTTP.StackClient.addRequestHeader"}
@@ -88,4 +87,3 @@
 - error: {lhs: "Network.HTTP.Types.hContentMD5", rhs: "Network.HTTP.StackClient.hContentMD5"}
 - error: {lhs: "Network.HTTP.Types.methodPut", rhs: "Network.HTTP.StackClient.methodPut"}
 - ignore: {name: "Use alternative", within: "Network.HTTP.StackClient"}
-- ignore: {name: "Use withResponseByManager", within: "Network.HTTP.StackClient"}
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -7,6 +7,37 @@ Release notes:
 
 Major changes:
 
+* Switch over to pantry for managing packages. This is a major change
+  to Stack's internals, and affects user-visible behavior in a few
+  places. Some highlights:
+    * Drop support for multiple package indices and legacy
+      `00-index.tar` style indices. See
+      [#4137](https://github.com/commercialhaskell/stack/issues/4137).
+    * Support for archives and repos in the `packages` section has
+      been removed. Instead, you must use `extra-deps` for such
+      dependencies. `packages` now only supports local filepaths.
+    * Addition of new configuration options for specifying a "pantry
+      tree" key, which provides more reproducibility around builds,
+      and (in the future) will be used for more efficient package
+      content downloads. You can also specify package name and version
+      for more efficient config parsing.
+          * __NOTE__ The new `stack freeze` command provides support
+            for automatically generating this additional
+            information.
+    * Package contents and metadata are stored in an SQLite database
+      in place of files on the filesystem. The `pantry` library can be
+      used for interacting with these contents.
+    * Internally, Stack has changed many datatypes, including moving
+      to Cabal's definition of many data types. As a result of such
+      changes, existing cache files will in general be invalidated,
+      resulting in Stack needing to rebuild many previously cached
+      builds in the new version. Sorry :(.
+    * A new command, `stack freeze` has been added which outputs
+      project and snapshot definitions with dependencies pinned to
+      their exact versions.
+    * The `ignore-revision-mismatch` setting is no longer needed, and
+      has been removed.
+
 Behavior changes:
 
 Other enhancements:
@@ -23,9 +54,21 @@ Other enhancements:
   redefine the default styles that stack uses to color some of its output. See
   `stack --help` for more information.
 * New build option `--ddump-dir`. (See [#4225](https://github.com/commercialhaskell/stack/issues/4225))
+* Stack parses and respects the `preferred-versions` information from
+  Hackage for choosing latest version of a package in some cases,
+  e.g. `stack unpack packagename`.
+* Git repos are shared across multiple projects. See
+  [#3551](https://github.com/commercialhaskell/stack/issues/3551)
 
 Bug fixes:
 
+* Ignore duplicate files for a single module when a Haskell module was
+  generated from a preprocessor file. See
+  [#4076](https://github.com/commercialhaskell/stack/issues/4076).
+* Only track down components in current directory if there are no
+  hs-source-dirs found. This eliminates a number of false-positive
+  warnings, similar to
+  [#4076](https://github.com/commercialhaskell/stack/issues/4076).
 * Handle a change in GHC's hi-dump format around `addDependentFile`,
   which now includes a hash. See
   [yesodweb/yesod#1551](https://github.com/yesodweb/yesod/issues/1551)

diff --git a/doc/GUIDE.md b/doc/GUIDE.md
@@ -8,6 +8,11 @@ This guide takes a new stack user through the typical workflows. This guide
 will not teach Haskell or involve much code, and it requires no prior experience
 with the Haskell packaging system or other build tools.
 
+__NOTE__ This document is probably out of date in some places and
+deserves a refresh. If you find this document helpful, please drop a
+note on [issue
+#4252](https://github.com/commercialhaskell/stack/issues/4252).
+
 ## Stack's functions
 
 stack handles the management of your toolchain (including GHC — the Glasgow

diff --git a/doc/architecture.md b/doc/architecture.md
@@ -2,6 +2,12 @@
 
 # Architecture
 
+__NOTE__ MSS 2018-08-22 This document is out of date, and will be made
+more out of date by
+[#3922](https://github.com/commercialhaskell/stack/issues/3922). I
+intend to update it when implementing #3922. Tracked in
+[#4251](https://github.com/commercialhaskell/stack/issues/4251).
+
 ## Terminology
 
 * Package identifier: a package name and version, e.g. text-1.2.1.0

diff --git a/doc/custom_snapshot.md b/doc/custom_snapshot.md
@@ -2,132 +2,4 @@
 
 # Custom Snapshots
 
-Custom snapshots were totally reworked with the extensible snapshots
-overhaul in Stack 1.6.0, see
-[the writeup](https://www.fpcomplete.com/blog/2017/07/stacks-new-extensible-snapshots)
-and
-[PR #3249](https://github.com/commercialhaskell/stack/pull/3249)). This
-documentation covers the new syntax only.
-
-Custom snapshots allow you to create your own snapshots, which provide
-a list of packages to use, along with flags, ghc-options, and a few
-other settings. Custom snapshots may extend any other snapshot that
-can be specified in a `resolver` field. The packages specified follow
-the syntax of `extra-deps` in the `stack.yaml` file, with one
-exception: to ensure reproducibility of snapshots, local directories
-are not allowed for custom snapshots (as they are expected to change
-regularly).
-
-```yaml
-resolver: lts-8.21 # Inherits GHC version and package set
-compiler: ghc-8.0.1 # Overwrites GHC version in the resolver, optional
-
-name: my-snapshot # User-friendly name
-
-# Additional packages, follows extra-deps syntax
-packages:
-- unordered-containers-0.2.7.1
-- hashable-1.2.4.0
-- text-1.2.2.1
-
-# Override flags, can also override flags in the parent snapshot
-flags:
-  unordered-containers:
-    debug: true
-
-# Packages from the parent snapshot to ignore
-drop-packages:
-- wai-extra
-
-# Packages which should be hidden (affects script command's import
-# parser
-hidden:
-  wai: true
-  warp: false
-
-# Set GHC options for specific packages
-ghc-options:
-  warp:
-  - -O2
-```
-
-If you put this in a `snapshot.yaml` file in the same directory as your project,
-you can now use the custom snapshot like this:
-
-```yaml
-resolver: snapshot.yaml
-```
-
-This is an example of a custom snapshot stored in the filesystem. They are
-assumed to be mutable, so you are free to modify it. We detect that the snapshot
-has changed by hashing the contents of the involved files, and using it to
-identify the snapshot internally. It is often reasonably efficient to modify a
-custom snapshot, due to stack sharing snapshot packages whenever possible.
-
-## Using a URL instead of a filepath
-
-For efficiency, URLs are treated differently. If I uploaded the snapshot to
-`https://domain.org/snapshot-1.yaml`, it is expected to be immutable. If you
-change that file, then you lose any reproducibility guarantees.
-
-### Overriding the compiler
-
-The following snapshot specification will be identical to `lts-7.1`, but instead
-use `ghc-7.10.3` instead of `ghc-8.0.1`:
-
-```yaml
-resolver: lts-7.1
-compiler: ghc-7.10.3
-```
-
-### Dropping packages
-
-The following snapshot specification will be identical to `lts-7.1`, but without
-the `text` package in our snapshot. Removing this package will cause all the
-packages that depend on `text` to be unbuildable, but they will still be present
-in the snapshot.
-
-```yaml
-resolver: lts-7.1
-drop-packages:
-  - text
-```
-
-### Specifying ghc-options
-
-In order to specify ghc-options for a package, you use the same syntax as the
-[ghc-options](yaml_configuration.md#ghc-options) field for build configuration.
-The following snapshot specification will be identical to `lts-7.1`, but
-provides `-O1` as a ghc-option for `text`:
-
-```yaml
-resolver: lts-7.1
-packages:
-  - text-1.2.2.1
-ghc-options:
-  text: -O1
-```
-
-This works somewhat differently than the stack.yaml `ghc-options` field, in that
-options can only be specified for packages that are mentioned in the custom
-snapshot's `packages` list. It sets the ghc-options, rather than extending those
-specified in the snapshot being extended.
-
-Another difference is that the `*` entry for `ghc-options` applies to all
-packages in the `packages` list, rather than all packages in the snapshot.
-
-### Specifying flags
-
-In order to specify flags for a package, you use the same syntax as the
-[flags](yaml_configuration.md#flags) field for build configuration. The
-following snapshot specification will be identical to `lts-7.1`, but
-it enables the `developer` cabal flag:
-
-```yaml
-resolver: lts-7.1
-packages:
-  - text-1.2.2.1
-flags:
-  text:
-    developer: true
-```
+This content has been moved to the [docs on pantry](pantry.md).