Skip to content

Commit

Permalink
Simplify note on relaxing version bounds
Browse files Browse the repository at this point in the history
- Link to GHC release note included or boot packages
  • Loading branch information
philderbeast committed Sep 9, 2024
1 parent da2154a commit 8438aff
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions doc/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,9 @@ the following file named ``myscript``:
.. note::

Version bounds are recommended but widening or dropping version bound
constraints on some packages, especially boot packages like base, for
single-file scripts will allow the script to run with a wider range of GHC
versions.
Widening or dropping version bound constraints on *packages included with
the compiler* [#boot-packages]_, like ``base``, will allow single-file
scripts to run with a wider range of compiler versions.

.. code-block:: diff
Expand Down Expand Up @@ -253,3 +252,9 @@ Now that you know how to set up a simple Haskell package using Cabal, check out
some of the resources on the Haskell website's `documentation page
<https://www.haskell.org/documentation/>`__ or read more about packages and
Cabal on the :doc:`What Cabal does <cabal-context>` page.

.. [#boot-packages] Packages included with the compiler are also called boot
packages. Each GHC compiler version has accompanying `release notes`_ that
list these included packages.
.. _release notes: https://downloads.haskell.org/ghc/latest/docs/users_guide/release-notes.html

0 comments on commit 8438aff

Please sign in to comment.