hasufell/ghcup-hs
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation around tags

Browse Source
This commit is contained in:
Julian Ospald 2023-10-01 14:33:37 +08:00
parent f0b145d8dd
commit c0ffb22d6a
No known key found for this signature in database
GPG Key ID: 4275CDA6A29BED43
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/guide.md
View File

@ -43,6 +43,14 @@ All of the following are valid arguments to `ghcup install ghc`:
If the argument is omitted, the default is `recommended`. 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 ## 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. 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.

17
lib/GHCup/Types.hs
View File

@ -158,12 +158,17 @@ instance NFData VersionInfo
-- | A tag. These are currently attached to a version of a tool. -- | A tag. These are currently attached to a version of a tool.
data Tag = Latest data Tag = Latest
| Recommended | Recommended -- ^ the recommended version of a tool
| Prerelease | Prerelease -- ^ denotes a prerelease version
| LatestPrerelease -- (a version should either be 'Prerelease' or
| Nightly -- 'LatestPrerelease', but not both)
| LatestNightly | LatestPrerelease -- ^ the latest prerelease (there should be only
| Base PVP -- 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 | Old -- ^ old versions are hidden by default in TUI
| UnknownTag String -- ^ used for upwardscompat | UnknownTag String -- ^ used for upwardscompat
deriving (Ord, Eq, GHC.Generic, Show) -- FIXME: manual JSON instance deriving (Ord, Eq, GHC.Generic, Show) -- FIXME: manual JSON instance