Improve documentation around tags

haskell · Oct 1, 2023 · c0ffb22 · c0ffb22
1 parent f0b145d
commit c0ffb22
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 6 deletions.
diff --git a/docs/guide.md b/docs/guide.md
@@ -43,6 +43,14 @@ All of the following are valid arguments to `ghcup install ghc`:
 
 If the argument is omitted, the default is `recommended`.
 
+Other tags include:
+
+- `prerelease`: a prerelease version
+- `latest-prerelease`: the latest prerelease version
+- `nightly`: a nightly version
+- `latest-nightly`: the latest nightly version
+
+
 ## Manpages
 
 For man pages to work you need [man-db](http://man-db.nongnu.org/) as your `man` provider, then issue `man ghc`. Manpages only work for the currently set ghc.

diff --git a/lib/GHCup/Types.hs b/lib/GHCup/Types.hs
@@ -158,12 +158,17 @@ instance NFData VersionInfo
 
 -- | A tag. These are currently attached to a version of a tool.
 data Tag = Latest
-         | Recommended
-         | Prerelease
-         | LatestPrerelease
-         | Nightly
-         | LatestNightly
-         | Base PVP
+         | Recommended        -- ^ the recommended version of a tool
+         | Prerelease         -- ^ denotes a prerelease version
+                              --   (a version should either be 'Prerelease' or
+                              --   'LatestPrerelease', but not both)
+         | LatestPrerelease   -- ^ the latest prerelease (there should be only
+                              --   one per tool)
+         | Nightly            -- ^ denotes a nightly version
+                              --   (a version should either be 'Nightly' or
+                              --   'LatestNightly', but not both)
+         | LatestNightly      -- ^ the latest nightly (there should be only one per tool)
+         | Base PVP           -- ^ the base version shipped with GHC
          | Old                -- ^ old versions are hidden by default in TUI
          | UnknownTag String  -- ^ used for upwardscompat
          deriving (Ord, Eq, GHC.Generic, Show) -- FIXME: manual JSON instance