Skip to content

Commit dcec87d

Browse files
authored
Merge pull request #6120 from commercialhaskell/pretty-setup
Make `stack setup` errors prettier
2 parents f08cb25 + 9d97a93 commit dcec87d

File tree

2 files changed

+353
-279
lines changed

2 files changed

+353
-279
lines changed

doc/maintainers/stack_errors.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
In connection with considering Stack's support of the
66
[Haskell Error Index](https://errors.haskell.org/) initiative, this page seeks
77
to take stock of the errors that Stack itself can raise, by reference to the
8-
`master` branch of the Stack repository. Last updated: 2023-05-05.
8+
`master` branch of the Stack repository. Last updated: 2023-05-12.
99

1010
* `Main.main`: catches exceptions from action `commandLineHandler`.
1111

@@ -258,16 +258,25 @@ to take stock of the errors that Stack itself can raise, by reference to the
258258
- `Stack.Setup.SetupException`
259259

260260
~~~haskell
261-
[S-1852] = UnsupportedSetupCombo OS Arch
261+
[S-2076] = WorkingDirectoryInvalidBug
262+
[S-3967] | StackBinaryArchiveZipUnsupportedBug
263+
~~~
264+
265+
- `Stack.Setup.SetupPrettyException`
266+
267+
~~~haskell
268+
[S-7441] = GHCInstallFailed SomeException StyleDoc String [String] (Path Abs Dir) (Path Abs Dir) (Path Abs Dir)
269+
[S-2476] | InvalidGhcAt (Path Abs File) SomeException
270+
[S-4764] | ExecutableNotFound [Path Abs File]
271+
[S-9953] | SandboxedCompilerNotFound [String] [Path Abs Dir]
272+
[S-1852] | UnsupportedSetupCombo OS Arch
262273
[S-2126] | MissingDependencies [String]
263274
[S-9443] | UnknownCompilerVersion (Set Text) WantedCompiler (Set ActualCompiler)
264275
[S-6810] | UnknownOSKey Text
265276
[S-5159] | GHCSanityCheckCompileFailed SomeException (Path Abs File)
266-
[S-9030] | WantedMustBeGHC
267277
[S-8948] | RequireCustomGHCVariant
268278
[S-2905] | ProblemWhileDecompressing (Path Abs File)
269279
[S-9561] | SetupInfoMissingSevenz
270-
[S-1457] | DockerStackExeNotFound Version Text
271280
[S-7748] | UnsupportedSetupConfiguration
272281
[S-5308] | MSYS2NotFound Text
273282
[S-5127] | UnwantedCompilerVersion
@@ -287,10 +296,8 @@ to take stock of the errors that Stack itself can raise, by reference to the
287296
[S-1827] | UnknownArchiveStructure (Path Abs File)
288297
[S-9476] | StackReleaseInfoNotFound String
289298
[S-4461] | StackBinaryArchiveNotFound [String]
290-
[S-2076] | WorkingDirectoryInvalidBug
291299
[S-6617] | HadrianBindistNotFound
292300
[S-7227] | DownloadAndInstallCompilerError
293-
[S-3967] | StackBinaryArchiveZipUnsupportedBug
294301
[S-6636] | StackBinaryArchiveUnsupported Text
295302
[S-7871] | StackBinaryNotInArchive String Text
296303
[S-5046] | FileTypeInArchiveInvalid Entry Text
@@ -299,15 +306,6 @@ to take stock of the errors that Stack itself can raise, by reference to the
299306
[S-4230] | ExistingMSYS2NotDeleted (Path Abs Dir) IOException
300307
~~~
301308

302-
- `Stack.Setup.SetupPrettyException`
303-
304-
~~~haskell
305-
[S-7441] = GHCInstallFailed SomeException StyleDoc String [String] (Path Abs Dir) (Path Abs Dir) (Path Abs Dir)
306-
[S-2476] | InvalidGhcAt (Path Abs File) SomeException
307-
[S-4764] | ExecutableNotFound [Path Abs File]
308-
[S-9953] | SandboxedCompilerNotFound [String] [Path Abs Dir]
309-
~~~
310-
311309
- `Stack.Storage.User.StorageUserException`
312310

313311
~~~haskell

0 commit comments

Comments
 (0)