Merge remote-tracking branch 'origin/pr/1048'

Installing a ghcjs bindist might require to install
a specific version of emscripten, and not the latest.

docs/BUGS.md

@@ -1 +0,0 @@
-# Known BUGS

docs/TODO.md

@@ -1,39 +0,0 @@
-# TODOs and Remarks
-
-## Now
-
-* ghcup init?
-* merge two download files
-* fetch/unpack functionality
-* installing multiple versions of the same
-* post-install
-
-* proper test suite
-
-* !! update of 0.1.5 must go in ghcup-0.0.1.json !!
-
-* try to run exe before upgrade (backup to ~/.ghcup/bin/ghcup.old)
-* stdout flushing?
-* resume support (for make-install only)
-
-## Maybe
-
-* version ranges in json
-* sign the JSON? (Or check gpg keys?)
-* testing (especially distro detection -> unit tests)
-
-## Later
-
-* add support for RC/alpha/HEAD versions
-
-## Cleanups
-
-* avoid alternative for IO
-* use plucky or oops instead of Excepts
-
-## Questions
-
-* move out GHCup.Version module, bc it's not library-ish?
-* mirror support
-* interactive handling when distro doesn't exist and we know the tarball is incompatible?
-* ghcup-with wrapper to execute a command with a given ghc in PATH?

docs/about.md

@@ -40,6 +40,80 @@ All you wanted to know about GHCup.
 * [haskell.org](https://www.haskell.org/haskell-org-committee/) via CI and infrastructure
 * [Haskell Foundation](https://haskell.foundation/affiliates/) via affiliation
 
+## Project ownership and hierarchy
+
+The project at the time of writing (2024-04-22) follows the model of
+[benevolent dictator for life](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), which is
+Julian Ospald at the moment.
+
+Ideally, the ownership should be shared across a core team of collaborators sharing the same vision and
+engagement in the future.
+
+I do not believe in people making decisions over projects they are barely involved in. Instead I believe
+in listening to end users needs very carefully and making decisions based on that. People who want a direct
+influence on the decision process have to both demonstrate they share the vision of GHCup and do the actual
+work.
+
+"Work" here doesn't have to be "writing code". There are many ways to be engaged in a project.
+
+### Transition plan in case of maintainer absence
+
+In case the current maintainer of GHCup (Julian Ospald) is unreachable for a prolonged period of time (3 months),
+the ownership of this project will be automatically transferred to the following individuals:
+
+- [Moritz Angerman](https://github.com/angerman)
+- [Andrew Lelechenko](https://github.com/Bodigrim)
+
+They will be tasked with finding new maintainers in whatever way they see fit (be it appointing themselves or asking HF for help).
+
+The appointed owners may choose to stay owners after the transition period (whether it's in a passive or active capacity) or
+fully transfer ownership to someone else or an organization.
+
+The community shall be informed about this process.
+
+If not otherwise specified by the newly appointed owners, the following principles shall apply to the *transition period*:
+
+#### During the transition period
+
+During the transition period, no other individual or organization is allowed to drive changes to
+[ghcup-hs](https://github.com/haskell/ghcup-hs) repository, unless they are explicitly allowed to do so by the appointed owners.
+
+The following people (in addition to the owners) shall have full write access to the
+[ghcup-metadata](https://github.com/haskell/ghcup-metadata) repository
+(all files) for the length of the transition period, unless otherwise specified by the appointed owners:
+
+- [Ben Gamari](https://github.com/bgamari)
+- [Hécate Moonlight](https://github.com/Kleidukos)
+- [Mike Pilgrem](https://github.com/mpilgrem)
+- [Jens Petersen](https://github.com/juhp)
+
+Contributions to the metadata are expected to follow a review process. If that turns out to be impractical due to lack of engagement, a wait
+time of 2 days before merging shall be followed anyway, except for the `-vanilla` files, which may be merged at any time.
+
+#### Access
+
+The GHCup website, various scripts and unofficial bindists are hosted on haskell.org infrastructure. Contact the
+[Haskell.org committee](https://www.haskell.org/haskell-org-committee/) for access.
+
+The backup owners should already have admin rights on the GHCup repositories, which are hosted on the
+[Github haskell namespace](https://github.com/haskell). In case of issues contact one of the
+organization admins for access, e.g.:
+
+- [Andrew Lelechenko](https://github.com/orgs/haskell/people/Bodigrim)
+- [gbaz](https://github.com/orgs/haskell/people/gbaz)
+- [Hécate Moonlight](https://github.com/Kleidukos)
+- [davean](https://github.com/orgs/haskell/people/davean)
+- [chessai](https://github.com/orgs/haskell/people/chessai)
+
+The owners should already have access to the [hackage package](https://hackage.haskell.org/package/ghcup/maintainers/).
+In case of issues contact the [hackage trustees](https://github.com/haskell-infra/hackage-trustees).
+
+#### Private runners
+
+Private runners maintained by Julian Ospald may cease to work. Moritz Angerman will have SSH access to the machines.
+However, no one will have access to the Hetzner account and billing information. As such, those runners will simply
+have to be replaced.
+
 ## How to help
 
 * if you want to contribute code or documentation, check out the [issue tracker](https://github.com/haskell/ghcup-hs/issues) and the [Development guide](./dev.md)
@@ -113,7 +187,7 @@ cabal-install/HLS/stack are installed in `~/.ghcup/bin/<tool>-<ver>` and have un
 ### Custom ghc version names
 
 When installing ghc bindists with custom version names as outlined in
-[installing custom bindists](#installing-custom-bindists), then cabal might
+[installing custom bindists](guide.md#installing-custom-bindists), then cabal might
 be unable to find the correct `ghc-pkg` (also see [#73](https://gitlab.haskell.org/haskell/ghcup-hs/-/issues/73))
 if you use `cabal build --with-compiler=ghc-foo`. Instead, point it to the full path, such as:
 `cabal build --with-compiler=$HOME/.ghcup/ghc/<version-name>/bin/ghc` or set that GHC version

docs/css/extra.css

@@ -146,6 +146,14 @@ a:hover {
   color: #996FC2;
 }
 
+#toc-collapse a.nav-link {
+  color: var(--link-pink);
+}
+
+#toc-collapse a:hover.nav-link {
+  color: #996FC2;
+}
+
 .col-md-9 img.main-logo {
   border: 0px;
   padding: 0px;

docs/guide.md

@@ -151,7 +151,7 @@ of metadata files to understand their purpose. These can be combined.
 For example, if you want access to both prerelease and cross bindists, you'd do:
 
 ```sh
-ghcup config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.7.yaml
+ghcup config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.8.yaml
 ghcup config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-cross-0.0.8.yaml
 ```
 
@@ -180,7 +180,7 @@ url-source:
 Also see [config.yaml](https://github.com/haskell/ghcup-hs/blob/master/data/config.yaml)
 for more options.
 
-You can also use an alternative metadata via one-shot cli option:
+You can also use an alternative metadata via the one-shot CLI option:
 
 ```sh
 ghcup --url-source=https://some-url/ghcup-0.0.8.yaml tui
@@ -200,14 +200,14 @@ url-source:
   - https://mirror.sjtu.edu.cn/ghcup/yaml/ghcup/data/ghcup-0.0.6.yaml
 ```
 
-Note that later versions of GHCup allow more sophisticated mirror support, see [here](./#mirrors-proper).
+Note that later versions of GHCup allow more sophisticated mirror support, see [here](#mirrors-proper).
 
 #### Known mirrors
 
 1. [https://mirror.sjtu.edu.cn/docs/ghcup](https://mirror.sjtu.edu.cn/docs/ghcup)
 2. [https://mirrors.ustc.edu.cn/help/ghcup.html](https://mirrors.ustc.edu.cn/help/ghcup.html)
 
-### Git based metadata config
+### Git-based metadata config
 
 If you don't like the way ghcup updates its metadata with caching and fetching via curl, you can also do as follows:
 
@@ -322,8 +322,24 @@ Stack metadata doesn't have a concept of those and we don't try to be smart when
 
 ### Windows
 
-On windows, you may find the following config options useful too:
+#### Using GHCup's MSYS2 installation
-`skip-msys`, `extra-path`, `extra-include-dirs`, `extra-lib-dirs`.
+
+Stack usually maintains its own msys2 installation. However, you can instruct it to use GHCup's MSYS2 or any other. E.g. if you
+had GHCup install msys2 into `C:\ghcup\msys64\`, then you would add the following config to stack's `config.yaml`
+(you can find its location via `stack path --stack-root`):
+
+```yaml
+skip-msys: true
+extra-lib-dirs:
+- C:\ghcup\msys64\mingw64\lib
+- C:\ghcup\msys64\mingw64\bin
+extra-path:
+- C:\ghcup\msys64\mingw64\bin
+- C:\ghcup\msys64\usr\bin
+- C:\ghcup\msys64\usr\local\bin
+extra-include-dirs:
+- C:\ghcup\msys64\mingw64\include
+```
 
 Also check out: [https://docs.haskellstack.org/en/stable/yaml_configuration](https://docs.haskellstack.org/en/stable/yaml_configuration)
 
@@ -543,19 +559,24 @@ The next sections explain how to install each cross bindist.
 
 ### GHC JS cross bindists (experimental)
 
-You need the required emscripten JS toolchain:
+You need the required emscripten JS toolchain. GHC JS cross bindists might require you to install a specific
+version of emscripten. If that is the case, then ghcup will display the required emscripten version in the
+pre install message. You can use the following commands to install the emscripten toolchain on your system,
+substituting the required version for the bindist that you want to install.
+(Cf. [GHC-MR 10918](https://gitlab.haskell.org/ghc/ghc/-/merge_requests/10918))
 
 ```sh
 git clone https://github.com/emscripten-core/emsdk.git
 cd emsdk
-./emsdk install latest
+./emsdk install VERSION
-./emsdk activate latest
+./emsdk activate VERSION
 source ./emsdk_env.sh
 ```
 
-Instructions are also here: [Download and install — Emscripten 3.1.43-git (dev) documentation](https://emscripten.org/docs/getting_started/downloads.html).
+Instructions are also here: [Download and install — Emscripten documentation](https://emscripten.org/docs/getting_started/downloads.html).
 
-To install we need to invoke ghcup like so:
+To install you can either use the tui interface by invoking `emconfigure ghcup tui` or
+you can install directly like so:
 
 ```sh
 emconfigure ghcup install ghc --set javascript-unknown-ghcjs-9.6.2

docs/install.md

@@ -1,7 +1,7 @@
 # Installation
 
 GHCup makes it easy to install specific versions of GHC on GNU/Linux,
-macOS (aka Darwin), FreeBSD and Windows and can also bootstrap a fresh [Haskell developer environment](./#supported-tools) from scratch.
+macOS (aka Darwin), FreeBSD and Windows and can also bootstrap a fresh [Haskell developer environment](#supported-tools) from scratch.
 It follows the UNIX philosophy of [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well). Similar in scope to [rustup](https://github.com/rust-lang-nursery/rustup.rs), [pyenv](https://github.com/pyenv/pyenv) and [jenv](http://www.jenv.be).
 
 ## How to install
@@ -32,7 +32,7 @@ GHCup has two main channels for every tool: **recommended** and **latest**. By d
 
 *latest* follows the latest release of every tool, while *recommended* is at the discretion of the GHCup maintainers and based on community adoption (hackage libraries, tools like HLS, stackage support, etc.) and known bugs.
 
-Also see [tags and shortcuts](../guide/#tags-and-shortcuts) for more information.
+Also see [tags and shortcuts](guide.md#tags-and-shortcuts) for more information.
 
 ## System requirements
 
@@ -121,9 +121,9 @@ On Windows, msys2 should already have been set up during the installation, so mo
 
 ## Next steps
 
-1. Follow the [First steps guide](../steps) on how to build a "Hello world" program, use `ghc`, run an interactive REPL and create a Haskell project
+1. Follow the [First steps guide](steps.md) on how to build a "Hello world" program, use `ghc`, run an interactive REPL and create a Haskell project
 2. To understand the difference and overlap of `stack` and `cabal`, read on [here](https://gist.github.com/merijn/8152d561fb8b011f9313c48d876ceb07)
-3. To learn Haskell proper check out the links at [How to learn Haskell proper](../steps#how-to-learn-haskell-proper)
+3. To learn Haskell proper check out the links at [How to learn Haskell proper](steps.md#how-to-learn-haskell-proper)
 4. To learn more about Haskell Toolchain management, check out the [ghcup user guide](./guide.md)
 
 ## Uninstallation
@@ -382,7 +382,7 @@ All set. You can run `cabal init` now in an empty directory to start a project.
 ### Void Linux
 
 Since void linux can be installed with glibc and musl, it's hard to support correctly with ghcup.
-One way to make ghcup work on **Void Linux musl** is to follow the [Overriding distro detection](../guide/#overriding-distro-detection)
+One way to make ghcup work on **Void Linux musl** is to follow the [Overriding distro detection](guide.md#overriding-distro-detection)
 section and tell it to consider Alpine bindists only. E.g.:
 
 ```sh

docs/steps.md

@@ -13,7 +13,7 @@ installed a Haskell toolchain:
 The Glorious Glasgow Haskell Compilation System, version 8.10.7
 ```
 
-If this fails, consult [the Getting started page](../install) for information on
+If this fails, consult [the Getting started page](install.md) for information on
 how to install Haskell on your computer.
 
 This guide is partly based on [Gil Mizrahi's blog](https://gilmi.me/blog/post/2021/08/14/hs-core-tools).