|
| 1 | +<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div> |
| 2 | + |
| 3 | +# Glossary |
| 4 | + |
| 5 | +The following terms are used in Stack's documentation. |
| 6 | + |
| 7 | +|Term |Meaning | |
| 8 | +|-------------------|----------------------------------------------------------| |
| 9 | +|Cabal |The Haskell Common Architecture for Building Applications and Libraries, provided by the [`Cabal` package](https://hackage.haskell.org/package/Cabal). Also referred to as Cabal (the library) to distinguish it from Cabal (the tool).| |
| 10 | +|Cabal file|A file containing a [package description](https://cabal.readthedocs.io/en/stable/cabal-package.html) used by Cabal, named `<package_name>.cabal`.| |
| 11 | +|Cabal (the tool)|The Haskell build tool provided by the [`cabal-install` package](https://hackage.haskell.org/package/cabal-install).| |
| 12 | +|`config.yaml` |A non-project-specific configuration file used by Stack. | |
| 13 | +|Docker |A [platform](https://www.docker.com/) for developing, shipping, and running applications. It can package and run an application in a loosely isolated environment called a _container_.| |
| 14 | +|Emacs |[GNU Emacs](https://www.gnu.org/software/emacs/), an extensible, customisable text editor.| |
| 15 | +|extra-deps |Packages in addition to those in a snapshot, named after a key used in `stack.yaml` files.| |
| 16 | +|FreeBSD |A Unix-like operating system. | |
| 17 | +|GCC |The [GNU Compiler Collection](https://gcc.gnu.org/) or its executable `gcc`.| |
| 18 | +|GHC |The [Glasgow Haskell Compiler](https://www.haskell.org/ghc/).| |
| 19 | +|GHCi |GHC's [interactive environment](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/ghci.html).| |
| 20 | +|GHCJS |A Haskell to JavaScript [compiler](https://github.com/ghcjs/ghcjs).| |
| 21 | +|GHCup |An [installer](https://www.haskell.org/ghcup/) for Haskell. |
| 22 | +|Git |A [distributed version control system](https://git-scm.com/).| |
| 23 | +|Hackage |The [Haskell Package Repository](https://hackage.haskell.org/). |
| 24 | +|'Haskell' extension|The ['Haskell' extension]() for VS Code. | |
| 25 | +|HLS |[Haskell Language Server](https://haskell-language-server.readthedocs.io/en/latest/), an implementation of the Language Server Protocol for Haskell.| |
| 26 | +|Hpack |A [format](https://github.com/sol/hpack) for Haskell packages or the executable `hpack` that produces a Cabal file from `package.yaml`.| |
| 27 | +|Linux |A family of operating systems based on the Linux kernal. | |
| 28 | +|macOS |The primary operating system for Apple's Mac computers. Previously known as Mac OS X or OS X.| |
| 29 | +|MSYS2 |The [MSYS2](https://www.msys2.org/) software distribution and building platform for Windows.| |
| 30 | +|Nix |A purely functional [package manager](https://nixos.org/), available for Linux and macOS.| |
| 31 | +|`package.yaml` |A file that describes a package in the Hpack format. | |
| 32 | +|Pantry |A library for content-addressable Haskell package management, provided by the [`pantry` package](https://hackage.haskell.org/package/pantry). A dependency of Stack.| |
| 33 | +|REPL | An interactive (run-eval-print loop) programming environment.| |
| 34 | +|resolver |A synonym for snapshot. | |
| 35 | +|`Setup.hs` |A project-specific file used by Cabal to perform setup tasks.| |
| 36 | +|snapshot |A snapshot defines a GHC version, a set of packages, and build flags or other settings.| |
| 37 | +|Stack |The Haskell Tool Stack project or its executable `stack`. | |
| 38 | +|`stack.yaml` |A project-specific configuration file used by Stack. | |
| 39 | +|Stackage |A [distribution](https://www.stackage.org/) of compatible Haskell packages.| |
| 40 | +|Stack root |A directory in which Stack stores important files. See `stack path --stack-root`. On Windows, Stack also stores important files outside of the Stack root.| |
| 41 | +|Unix-like operating systems|Linux, FreeBSD and macOS. | |
| 42 | +|VS Code |[Visual Studio Code](https://code.visualstudio.com/), a source code editor.| |
| 43 | +|Windows |A group of operating systems developed by Microsoft. | |
| 44 | +|WSL |[Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/). Provides a Linux environment on Windows.| |
0 commit comments