Prefer snapshot to resolver in documentation

Author: mpilgrem

doc/GUIDE.md

@@ -247,18 +247,18 @@ settings. Ignoring comments beginning `#`, the contents will look something like
 this:
 
 ~~~yaml
-resolver:
-  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/8.yaml
+snapshot:
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/11.yaml
 packages:
 - .
 ~~~
 
-The value of the [`resolver`](yaml_configuration.md#resolver) key tells Stack
+The value of the [`snapshot`](yaml_configuration.md#snapshot) key tells Stack
 *how* to build your package: which GHC version to use, versions of package
 dependencies, and so on. Our value here says to use
-[LTS Haskell 22.7](https://www.stackage.org/lts-22.7), which implies GHC 9.6.4
+[LTS Haskell 22.11](https://www.stackage.org/lts-22.11), which implies GHC 9.6.4
 (which is why `stack build` installs that version of GHC if it is not already
-available to Stack). There are a number of values you can use for `resolver`,
+available to Stack). There are a number of values you can use for `snapshot`,
 which we'll cover later.
 
 The value of the `packages` key tells Stack which local packages to build. In
@@ -539,15 +539,15 @@ We can also change snapshots on the command line, which can be useful in a
 Continuous Integration (CI) setting, like on Travis. For example, command:
 
 ~~~text
-stack --resolver lts-20.26 build
+stack --snapshot lts-20.26 build
 # Downloaded lts-20.26 build plan.
 # build output ...
 ~~~
 
 When passed on the command line, you also get some additional "short-cut"
-versions of snapshots: `--resolver nightly` will use the newest Nightly snapshot
-available, `--resolver lts` will use the newest LTS, and `--resolver lts-21`
-will use the newest LTS in the 21.x series. The reason these are only available
+versions of snapshots: `--snapshot nightly` will use the newest Nightly snapshot
+available, `--snapshot lts` will use the newest LTS, and `--snapshot lts-22`
+will use the newest LTS in the 22.x series. The reason these are only available
 on the command line and not in your `stack.yaml` file is that using them:
 
 1. Will slow down your build (since Stack then needs to download information on
@@ -557,11 +557,11 @@ on the command line and not in your `stack.yaml` file is that using them:
 
 ### Changing GHC versions
 
-Finally, let's try using an older LTS snapshot. We'll use the newest 19.x
+Finally, let's try using an older LTS snapshot. We'll use the newest 21.x
 snapshot with the command:
 
 ~~~text
-stack --resolver lts-19 build
+stack --snapshot lts-21 build
 # build output ...
 ~~~
 
@@ -676,7 +676,7 @@ editing the configuration file and removing it.
 
 Sometimes you may want to use a specific snapshot for your project instead of
 `stack init` picking one for you. You can do that by using
-`stack init --resolver <snapshot>`.
+`stack init --snapshot <snapshot>`.
 
 You can also init with a compiler snapshot if you do not want to use a
 Stackage snapshot. That will result in all of your project's dependencies being
@@ -714,8 +714,8 @@ it. You may see something like this:
 
 ~~~text
 stack build
-Warning: Some packages were found to be incompatible with the resolver and have been left commented out in the packages section.
-Warning: Specified resolver could not satisfy all dependencies. Some external packages have been added as dependencies.
+Warning: Some packages were found to be incompatible with the snapshot and have been left commented out in the packages section.
+Warning: Specified snapshot could not satisfy all dependencies. Some external packages have been added as dependencies.
 You can suppress this message by removing it from stack.yaml
 ~~~
 
@@ -1056,8 +1056,8 @@ Selecting the best among 18 snapshots...
 
 * Matches ...
 
-Selected resolver: ...
-Initialising configuration using resolver: ...
+Selected snapshot: ...
+Initialising configuration using snapshot: ...
 Total number of user packages considered: 2
 Writing configuration to file: stack.yaml
 stack build --haddock --test
@@ -1067,7 +1067,7 @@ stack build --haddock --test
 If you look at the `stack.yaml` file, you'll see exactly what you'd expect:
 
 ~~~yaml
-resolver:
+snapshot:
   url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/17.yaml
 packages:
 - wai-app-static-3.1.7.4
@@ -1296,9 +1296,9 @@ yields output like:
 
 ~~~text
 Run from outside a project, using implicit global project config
-Using latest snapshot resolver: lts-22.7
+Using latest snapshot snapshot: lts-22.7
 Writing global (non-project-specific) config file to: /home/michael/.stack/global/stack.yaml
-Note: You can change the snapshot via the resolver field there.
+Note: You can change the snapshot via the snapshot field there.
 I installed the stm package via --package stm
 ~~~
 

doc/azure_ci.md

@@ -133,24 +133,24 @@ But we only use the first method of using Stack to download GHC.
 For different GHC versions, you probably want to use different project-level
 configuration files (`stack.yaml`). If you don't want to put a specific
 `stack.yaml` for a particular snapshot and still want to test it, you have
-specify your resolver argument in `ARGS` environment variable (you will see an
+specify your snapshot argument in `ARGS` environment variable (you will see an
 example below).
 
 ~~~yaml
 strategy:
   matrix:
     GHC 8.0:
-      ARGS: "--resolver lts-9"
+      ARGS: "--snapshot lts-9"
     GHC 8.2:
-      ARGS: "--resolver lts-11"
+      ARGS: "--snapshot lts-11"
     GHC 8.4:
-      ARGS: "--resolver lts-12"
+      ARGS: "--snapshot lts-12"
     GHC 8.6:
-      ARGS: "--resolver lts-14"
+      ARGS: "--snapshot lts-14"
     GHC 8.8:
-      ARGS: "--resolver lts-15"
+      ARGS: "--snapsht lts-15"
     nightly:
-      ARGS: "--resolver nightly"
+      ARGS: "--snapshot nightly"
 ~~~
 
 ## Running tests

doc/build_command.md

@@ -809,7 +809,7 @@ Examples:
     the most recent Stackage Nightly snapshot:
 
     ~~~text
-    stack --resolver nightly install Agda-2.6.3
+    stack --snapshot nightly install Agda-2.6.3
     ~~~
 
     Alternatively, Stack can be used to unpack the package from the package

doc/build_overview.md

@@ -72,7 +72,7 @@ in CLI).
 
 ## Wanted compiler, dependencies, and project packages
 
-* If the `--resolver` CLI is present, ignore the `snapshot` (or `resolver`) and
+* If the `--snapshot` CLI is present, ignore the `snapshot` (or `resolver`) and
   `compiler` config values
 * Load up the indicated snapshot (either config value or CLI arg). This will
   provide:
@@ -81,7 +81,7 @@ in CLI).
       are immutable.
     * A wanted compiler version, e.g. `ghc-8.6.5`
 * If the `--compiler` CLI arg is set, or the `compiler` config value
-  is set (and `--resolver` CLI arg is not set), ignore the wanted
+  is set (and `--snapshot` CLI arg is not set), ignore the wanted
   compiler from the snapshot and use the specified wanted compiler
 * Parse `extra-deps` into a `Map PackageName PackageLocation`,
   containing both mutable and immutable package locations. Parse

doc/faq.md

@@ -32,7 +32,7 @@ more recent LTS snapshot. You can do this using the following command from
 outside of a project:
 
 ~~~text
-stack config set resolver lts
+stack config set snapshot lts
 ~~~
 
 ## Where is Stack installed and will it interfere with the GHC (etc) I already have installed?

doc/list_command.md

@@ -13,15 +13,15 @@ version of the package from Hackage. If the package name cannot be found on
 Hackage, even after updating the package index, suggestions (not  necessarily
 good ones) will be made about the intended package name.
 
-`stack --resolver <snapshot> list <package_name>` will send to the standard
+`stack --snapshot <snapshot> list <package_name>` will send to the standard
 output stream the version of the package in the specified snapshot, unless the
 package comes with GHC on Unix-like operating systems. If the package name
 cannot be found in the snapshot, the command will fail, identifying only the
 package(s) that did not appear in the snapshot.
 
 More than one package name can be specified.
 
-`stack --resolver <snapshot> list` will send to the standard output stream a
+`stack --snapshot <snapshot> list` will send to the standard output stream a
 list of all the packages in the specified snapshot, except those which come with
 GHC on Unix-like operating systems.
 
@@ -44,17 +44,17 @@ Error: [S-4926]
          pantry, pretty, pasty, xattr, alloy, para, pappy, alure, polar and
          factory.
 
-stack --resolver lts-22.7 list base unix Win32 acme-missiles pantry
+stack --snapshot lts-22.7 list base unix Win32 acme-missiles pantry
 Error: [S-4926]
        * Package does not appear in snapshot: base.
        * Package does not appear in snapshot: unix.
        * Package does not appear in snapshot: Win32.
        * Package does not appear in snapshot: acme-missiles.
 
-stack --resolver lts-22.7 list pantry
+stack --snapshot lts-22.7 list pantry
 pantry-0.9.3.1
 
-stack --resolver lts-22.7 list
+stack --snapshot lts-22.7 list
 AC-Angle-1.0
 ALUT-2.4.0.3
 ...

doc/maintainers/7zip.md

@@ -79,7 +79,7 @@ need to be updated frequently. On 10 September 2022, it was updated from 7-Zip
     * executing the command:
 
         ~~~text
-        stack --resolver <snapshot> setup --setup-info-yaml <path to local copy of stack-setup-2.yaml>
+        stack --snapshot <snapshot> setup --setup-info-yaml <path to local copy of stack-setup-2.yaml>
         ~~~
 
       where `<snapshot>` requires the missing version of GHC.

doc/maintainers/docker.md

@@ -67,7 +67,7 @@ with the previous minor LTS snapshot version.
 - Test the new image. For example, command:
 
     ~~~text
-    stack --resolver=lts-<N>.<M> new image-test
+    stack --snapshot=lts-<N>.<M> new image-test
     cd image-test
     stack --docker build
     ~~~
@@ -136,7 +136,7 @@ major LTS snapshot version.
 - Try building a test package with the new image. Command:
 
     ~~~text
-    stack --resolver=nightly new image-test`
+    stack --snapshot=nightly new image-test`
     cd image-test
     stack --docker --docker-image=local/stack-build build
     ~~~
@@ -152,7 +152,7 @@ major LTS snapshot version.
 - Try building a test package with the new small image. Command:
 
     ~~~text
-    stack --resolver=nightly new small-image-test
+    stack --snapshot=nightly new small-image-test
     cd small-image-test
     stack --docker --docker-image=local/stack-build-small build
     ~~~

doc/maintainers/ghc.md

@@ -40,7 +40,7 @@
   Before committing, test using a command like:
 
     ~~~text
-    stack --resolver=ghc-X.Y.Z setup --setup-info-yaml=path/to/stackage-content/stack/stack-setup-2.yaml
+    stack --snapshot=ghc-X.Y.Z setup --setup-info-yaml=path/to/stackage-content/stack/stack-setup-2.yaml
     ~~~
 
 * In [stackage-content](https://github.com/fpco/stackage-content), command:

doc/maintainers/releases.md

@@ -167,8 +167,8 @@ branch.
             (in the `.github` directory) to point at the new release version
             yet!
 
-    *   Search for old snapshot resolvers, set to latest snapshot (e.g. in
-        `doc/GUIDE.md` where it references the "currently the latest LTS")
+    *   Search for old snapshots, set to latest snapshot (e.g. in`doc/GUIDE.md`
+        where it references the "currently the latest LTS")
     *   Look for any links to "latest" (`latest/`) documentation, replace with
         version tag
 

doc/nix_integration.md

@@ -128,7 +128,7 @@ above to use Nix flakes. The `flake.nix` file is:
 
         hPkgs =
           pkgs.haskell.packages."ghc8107"; # need to match Stackage LTS version
-                                           # from stack.yaml snapshot resolver
+                                           # from stack.yaml snapshot
 
         myDevTools = [
           hPkgs.ghc # GHC compiler in the desired version (will be available on PATH)
@@ -310,7 +310,7 @@ The `buildStackProject` utility function is documented in the
 Stack expects the `shell.nix` file to define a function of with one argument
 called `ghc` (arguments are not positional), which you should give to
 function `buildStackProject`. This argument is a GHC Nix package in the
-version as defined in the resolver you set in Stack's project-level
+version as defined in the snapshot you set in Stack's project-level
 configuration file (`stack.yaml`).
 
 ### Pure and impure Nix shells

doc/script_command.md

@@ -15,10 +15,10 @@ default, runs it.
 
 Unlike `stack ghc` and `stack runghc`, the command ignores all Stack YAML
 configuration files (global and project-level). A snapshot must be specified on
-the command line (with the `--resolver` option). For example:
+the command line (with the `--snapshot` option). For example:
 
 ~~~text
-stack script --resolver lts-22.7 MyScript.hs
+stack script --snapshot lts-22.7 MyScript.hs
 ~~~
 
 The `stack script` command behaves as if the `--install-ghc` flag had been
@@ -100,7 +100,7 @@ main = do
 can be compiled and run, with arguments, with:
 
 ~~~text
-stack --resolver lts-22.7 script --package acme-missiles --compile MyScript.hs -- "Don't panic!" "Duck and cover!"
+stack --snapshot lts-22.7 script --package acme-missiles --compile MyScript.hs -- "Don't panic!" "Duck and cover!"
 ~~~
 
 All the compilation outputs (like `Main.hi`, `Main.o`, and the executable
@@ -123,7 +123,7 @@ LTS Haskell 20.25, where considerations on Windows differ from non-Windows. The
 
     ~~~haskell
     {- stack script
-       --resolver lts-20.25
+       --snapshot lts-20.25
        --extra-dep acme-missiles-0.3
        --extra-dep directory-1.3.6.2
        --extra-dep process-1.6.16.0
@@ -156,7 +156,7 @@ LTS Haskell 20.25, where considerations on Windows differ from non-Windows. The
 
     ~~~haskell
     {- stack script
-       --resolver lts-20.25
+       --snapshot lts-20.25
        --extra-dep acme-missiles-0.3
     -}