Release preparation: Bump references in documentation

mpilgrem · mpilgrem · commit 111f6c71218c · 2023-05-05T21:02:14.000+01:00
diff --git a/doc/GUIDE.md b/doc/GUIDE.md
@@ -248,15 +248,15 @@ this:
 
 ~~~yaml
 resolver:
-  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/28.yaml
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/20/19.yaml
 packages:
 - .
 ~~~
 
 The value of the `resolver` 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 19.28](https://www.stackage.org/lts-19.28), which
-implies GHC 9.0.2 (which is why `stack build` installs that version of GHC if it
+says to use [LTS Haskell 20.19](https://www.stackage.org/lts-20.19), which
+implies GHC 9.2.7 (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`, which we'll cover later.
 
@@ -503,7 +503,7 @@ also known as *snapshots*. We mentioned the LTS resolvers, and you can get quite
 a bit of information about it at
 [https://www.stackage.org/lts](https://www.stackage.org/lts), including:
 
-* The appropriate resolver value (`resolver: lts-20.4`, as is currently the
+* The appropriate resolver value (`resolver: lts-20.19`, as is currently the
   latest LTS)
 * The GHC version used
 * A full list of all packages available in this snapshot
@@ -522,16 +522,16 @@ towards by default as well).
 
 ## Resolvers and changing your compiler version
 
-Let's explore package sets a bit further. Instead of lts-19.17, let's change our
-`stack.yaml` file to use the [latest nightly](https://www.stackage.org/nightly).
-Right now, this is currently 2022-12-16 - please see the resolver from the link
-above to get the latest.
+Let's explore package sets a bit further. Instead of `lts-20.19`, let's change
+our `stack.yaml` file to use the
+[latest nightly](https://www.stackage.org/nightly). Right now, this is currently
+2023-05-05 - please see the resolver from the link above to get the latest.
 
 Then, commanding `stack build` again will produce:
 
 ~~~text
 stack build
-# Downloaded nightly-2022-12-16 build plan.
+# Downloaded nightly-2023-05-05 build plan.
 # build output ...
 ~~~
 
@@ -546,8 +546,8 @@ stack --resolver lts-18.28 build
 
 When passed on the command line, you also get some additional "short-cut"
 versions of resolvers: `--resolver nightly` will use the newest Nightly resolver
-available, `--resolver lts` will use the newest LTS, and `--resolver lts-19`
-will use the newest LTS in the 19.x series. The reason these are only available
+available, `--resolver lts` will use the newest LTS, and `--resolver lts-20`
+will use the newest LTS in the 20.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 18.x
+Finally, let's try using an older LTS snapshot. We'll use the newest 19.x
 snapshot with the command:
 
 ~~~text
-stack --resolver lts-18 build
+stack --resolver lts-19 build
 # build output ...
 ~~~
 
@@ -1340,7 +1340,7 @@ yields output like:
 
 ~~~text
 Run from outside a project, using implicit global project config
-Using latest snapshot resolver: lts-18.3
+Using latest snapshot resolver: lts-20.19
 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.
 I installed the stm package via --package stm
diff --git a/doc/Stack_and_VS_Code.md b/doc/Stack_and_VS_Code.md
@@ -75,9 +75,9 @@ enabled). For further information about these options, see the `install-ghc`
 
 For this workaround to work, each time that a resolver is used that references a
 different version of GHC, then GHCup must be used to install it (if GHCup has
-not already installed that version). For example, to use `resolver: lts-19.16`
-(GHC 9.0.2), the command `ghcup install ghc 9.0.2` must have been used to
-install GHC 9.0.2. That may be a minor inconvenience for some people, as one the
+not already installed that version). For example, to use `resolver: lts-20.19`
+(GHC 9.2.7), the command `ghcup install ghc 9.2.7` must have been used to
+install GHC 9.2.7. That may be a minor inconvenience for some people, as one the
 primary benefits of Stack over other Haskell build tools has been that Stack
 automatically ensures that the necessary version of GHC is available.
 
diff --git a/doc/build_command.md b/doc/build_command.md
@@ -414,7 +414,7 @@ expressions, and generate a backtrace on exception.
 
 ### `--PROG-option` options
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 2.11.1](https://github.com/commercialhaskell/stack/releases/tag/v2.11.1)
 
 `PROG` is a program recognised by Cabal (the library) and one of `alex`, `ar`,
 `c2hs`, `cpphs`, `gcc`, `greencard`, `happy`, `hsc2hs`, `hscolour`, `ld`,
diff --git a/doc/config_command.md b/doc/config_command.md
@@ -85,8 +85,8 @@ stack config set resolver SNAPSHOT
 project-level configuration file (`stack.yaml`).
 
 A snapshot of `lts` or `nightly` will be translated into the most recent
-available. A snapshot of `lts-19` will be translated into the most recent
-available in the `lts-19` sequence.
+available. A snapshot of `lts-20` will be translated into the most recent
+available in the `lts-20` sequence.
 
 Known bug:
 
diff --git a/doc/custom_snapshot.md b/doc/custom_snapshot.md
@@ -17,8 +17,8 @@ available in snapshots to ensure reproducibility.
     snapshot specification.
 
 ~~~yaml
-resolver: lts-8.21 # Inherits GHC version and package set
-compiler: ghc-8.0.1 # Overwrites GHC version in the resolver, optional
+resolver: lts-20.19 # Inherits GHC version and package set
+compiler: ghc-9.6.1 # Overwrites GHC version in the resolver, optional
 
 # Additional packages, follows extra-deps syntax
 packages:
@@ -61,51 +61,51 @@ custom snapshot, due to Stack sharing snapshot packages whenever possible.
 
 ### 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`:
+The following snapshot specification will be identical to `lts-20.19`, but instead
+use `ghc-9.2.6` instead of `ghc-9.2.7`:
 
 ~~~yaml
-resolver: lts-7.1
-compiler: ghc-7.10.3
+resolver: lts-20.19
+compiler: ghc-9.2.6
 ~~~
 
 ### Dropping packages
 
-The following snapshot specification will be identical to `lts-7.1`, but without
+The following snapshot specification will be identical to `lts-20.19`, 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
+resolver: lts-20.19
 drop-packages:
-  - text
+- text
 ~~~
 
 ### Hiding packages
 
-The following snapshot specification will be identical to `lts-7.1`, but the
+The following snapshot specification will be identical to `lts-20.19`, but the
 `text` package will be hidden when registering. This will affect, for example,
 the import parser in the script command.
 
 ~~~yaml
-resolver: lts-7.1
+resolver: lts-20.19
 hidden:
-  - text
+- 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) key for build configuration.
 
-The following snapshot specification will be identical to `lts-7.1`, but
+The following snapshot specification will be identical to `lts-20.19`, but
 provides `-O1` as a ghc-option for `text`:
 
 ~~~yaml
-resolver: lts-7.1
+resolver: lts-20.19
 packages:
-  - text-1.2.2.1
+- text-1.2.5.0
 ghc-options:
   text: -O1
 ~~~
@@ -122,13 +122,13 @@ packages in the `packages` list, rather than all packages in the snapshot.
 
 In order to specify Cabal flags for a package, you use the same syntax as the
 [flags](yaml_configuration.md#flags) key for build configuration. The
-following snapshot specification will be identical to `lts-7.1`, but
+following snapshot specification will be identical to `lts-20.19`, but
 it enables the `developer` Cabal flag:
 
 ~~~yaml
-resolver: lts-7.1
+resolver: lts-20.19
 packages:
-  - text-1.2.2.1
+- text-1.2.5.0
 flags:
   text:
     developer: true
diff --git a/doc/environment_variables.md b/doc/environment_variables.md
@@ -7,7 +7,7 @@ behaves.
 
 ## `GH_TOKEN` or `GITHUB_TOKEN`
 
-:octicons-tag-24: UNRELEASED
+[:octicons-tag-24: 2.11.1](https://github.com/commercialhaskell/stack/releases/tag/v2.11.1)
 
 Stack will use the value of the `GH_TOKEN` or, in the alternative,
 `GITHUB_TOKEN` environment variable (if not an empty string) as credentials to
diff --git a/doc/faq.md b/doc/faq.md
@@ -9,7 +9,7 @@ here is to be as helpful and concise as possible.
 ## What version of GHC is used when I run something like `stack ghci`?
 
 The version of GHC, as well as which packages can be installed, are specified by
-the _resolver_. This may be something like `lts-19.19`, which is from
+the _resolver_. This may be something like `lts-20.19`, which is from
 [Stackage](https://www.stackage.org/). The [user's guide](GUIDE.md) discusses
 the resolver in more detail.
 
@@ -76,11 +76,11 @@ You can make tweaks to a snapshot by modifying the `extra-deps` configuration
 value in your `stack.yaml` file, e.g.:
 
 ~~~yaml
-resolver: lts-19.19
+resolver: lts-20.19
 packages:
-- '.'
+- .
 extra-deps:
-- text-2.0.1
+- text-2.0.2
 ~~~
 
 ## I need to use a package (or version of a package) that is not available on Hackage, what should I do?
@@ -91,9 +91,9 @@ Add it to the
 directory where your `stack.yaml` file lives, e.g.
 
 ~~~yaml
-resolver: lts-19.19
+resolver: lts-20.19
 packages:
-- '.'
+- .
 extra-deps:
 - third-party/proprietary-dep
 - github-version-of/conduit
diff --git a/doc/list_command.md b/doc/list_command.md
@@ -13,43 +13,45 @@ 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> <package_name>` will list the version of the
+`stack --resolver <snapshot> list <package_name>` will list 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>` will list all the packages in the specified
+`stack --resolver <snapshot> list` will list all the packages in the specified
 snapshot, except those which come with GHC on Unix-like operating systems.
 
 For example:
 
 ~~~text
 stack list base unix Win32 acme-missiles pantry
-base-4.17.0.0
-unix-2.8.0.0
-Win32-2.13.3.0
+base-4.18.0.0
+unix-2.8.1.1
+Win32-2.13.4.0
 acme-missiles-0.3
-pantry-0.5.7
+pantry-0.8.1
 
 stack list paltry
 Could not find package paltry, updating
 ...
 Package index cache populated
-- Could not find package paltry on Hackage. Perhaps you meant: pretty, pasty, xattr, alloy, para, pappy, alure, polar, factory, pastis
+Error: [S-4926]
+- Could not find package paltry on Hackage. Perhaps you meant: retry, path, pantry, pretty, pasty, xattr, alloy, para, pappy, alure
 
-stack --resolver lts-19.25 base unix Win32 acme-missiles pantry
+stack --resolver lts-20.19 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: acme-missiles
 
-stack --resolver lts-19.25 Win32 pantry
+stack --resolver lts-20.19 list Win32 pantry
 Win32-2.12.0.1
 pantry-0.5.7
 
-stack --resolver lts-19.25
+stack --resolver lts-20.19 list
 AC-Angle-1.0
 ALUT-2.4.0.3
 ...
diff --git a/doc/maintainers/stack_errors.md b/doc/maintainers/stack_errors.md
@@ -5,7 +5,7 @@
 In connection with considering Stack's support of the
 [Haskell Error Index](https://errors.haskell.org/) initiative, this page seeks
 to take stock of the errors that Stack itself can raise, by reference to the
-`master` branch of the Stack repository. Last updated: 2023-04-30.
+`master` branch of the Stack repository. Last updated: 2023-05-05.
 
 *   `Main.main`: catches exceptions from action `commandLineHandler`.
 
diff --git a/doc/script_command.md b/doc/script_command.md
@@ -18,13 +18,13 @@ configuration files (global and project-level). A snapshot must be specified on
 the command line (with the `--resolver` option). For example:
 
 ~~~text
-stack --resolver lts-20.4 MyScript.hs
+stack --resolver lts-20.19 MyScript.hs
 ~~~
 
 or, equivalently:
 
 ~~~text
-stack script --resolver lts-20.4 MyScript.hs
+stack script --resolver lts-20.19 MyScript.hs
 ~~~
 
 The `stack script` command behaves as if the `--install-ghc` flag had been
@@ -82,7 +82,7 @@ main = do
 can be compiled and run, with arguments, with:
 
 ~~~text
-stack --resolver lts-20.4 script --package acme-missiles --compile MyScript.hs -- "Don't panic!" "Duck and cover!"
+stack --resolver lts-20.19 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
diff --git a/doc/scripts.md b/doc/scripts.md
diff --git a/doc/setup_command.md b/doc/setup_command.md
diff --git a/doc/stack_yaml_vs_cabal_package_file.md b/doc/stack_yaml_vs_cabal_package_file.md
diff --git a/doc/upgrade_command.md b/doc/upgrade_command.md
diff --git a/doc/yaml_configuration.md b/doc/yaml_configuration.md
