Hadrian: Update instructions for building on Windows
authorAndrey Mokhov <andrey.mokhov@gmail.com>
Sun, 27 Jan 2019 22:34:30 +0000 (22:34 +0000)
committerBen Gamari <ben@smart-cactus.org>
Thu, 31 Jan 2019 17:46:51 +0000 (12:46 -0500)
The `hadrian/doc/windows.md` file has falled out of date. In particular
it still points to the old GitHub repository, and uses incorrect path
to GHC. This patch fixes it.

hadrian/README.md
hadrian/doc/windows.md

index a3b8a1b..7b6646d 100644 (file)
@@ -262,7 +262,7 @@ projects), as well as Well-Typed.
 [issues]: https://github.com/snowleopard/hadrian/issues
 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
-[windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
+[windows-build]: https://gitlab.haskell.org/ghc/ghc/blob/master/hadrian/doc/windows.md
 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
index 0ad2086..aa59bc5 100644 (file)
@@ -1,15 +1,13 @@
 # Building GHC on Windows\r
 \r
-[![Windows status](https://img.shields.io/appveyor/ci/snowleopard/hadrian/master.svg?label=Windows)](https://ci.appveyor.com/project/snowleopard/hadrian)\r
+Here is how you can build GHC, from source, on Windows with minimal requirements.\r
+We only assume that `git` and `stack` are installed (see\r
+[prerequisites](https://github.com/snowleopard/hadrian/blob/master/doc/windows.md#prerequisites)).\r
 \r
-Here is how you can build GHC, from source, on Windows. We assume that `git` and `stack` are installed\r
-(see [prerequisites](https://github.com/snowleopard/hadrian/blob/master/doc/windows.md#prerequisites)).\r
-\r
-```sh\r
-# Get GHC and Hadrian sources; git core.autocrlf should be set to false (see Prerequisites section)\r
+```\r
+# Get GHC sources; git core.autocrlf should be set to false (see Prerequisites section)\r
 git clone --recursive git://git.haskell.org/ghc.git\r
 cd ghc\r
-git clone git://github.com/snowleopard/hadrian\r
 \r
 # Download and install the bootstrapping GHC and MSYS2\r
 cd hadrian\r
@@ -27,30 +25,33 @@ stack exec hadrian -- --directory ".." -j --flavour=quickest --configure
 \r
 # Test GHC\r
 cd ..\r
-inplace\bin\ghc-stage2 -e 1+2\r
+_build\stage1\bin\ghc -e 1+2\r
 ```\r
 \r
-The entire process should take about 20 minutes. Note, this will build GHC without\r
-optimisations. If you need an optimised GHC, drop the `--flavour=quickest` flag from\r
-the build command line (this will slow down the build to about an hour).\r
+The entire process should take about 20 minutes. Note, this will build GHC\r
+without optimisations. If you need an optimised GHC, drop the `--flavour=quickest`\r
+flag from the build command line (this will slow down the build to about an hour).\r
 \r
 These are currently not the\r
 [official GHC building instructions](https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows),\r
 but are much simpler and may also be more robust.\r
 \r
-The `stack build` and `stack exec hadrian` commands can be replaced by an invocation\r
-of Hadrian's Stack-based build script: `build.stack.bat -j --flavour=quickest`. Use this\r
-script if you plan to work on Hadrian and/or rebuild GHC often.\r
+The `stack build` and `stack exec hadrian` commands can be replaced by an\r
+invocation of Hadrian's Stack-based build script:\r
+`build.stack.bat -j --flavour=quickest`. Use this script if you plan to work on\r
+Hadrian and/or rebuild GHC often.\r
 \r
 ## Prerequisites\r
 \r
-The above works on a clean machine with `git` and `stack` installed (tested with default\r
-installation settings), which you can get from https://git-scm.com/download/win and\r
+The above works on a clean machine with `git` and `stack` installed (tested with\r
+default installation settings), which you can get from\r
+https://git-scm.com/download/win and\r
 https://www.stackage.org/stack/windows-x86_64-installer.\r
 \r
-Note that `git` should be configured to check out Unix-style line endings. The default behaviour\r
-of `git` on Windows is to check out Windows-style line endings which can cause issues during the\r
-build. This can be changed using the following command:\r
+Note that `git` should be configured to check out Unix-style line endings. The\r
+default behaviour of `git` on Windows is to check out Windows-style line endings\r
+which can cause issues during the build. This can be changed using the following\r
+command:\r
 \r
     git config --global core.autocrlf false\r
 \r
@@ -61,10 +62,10 @@ If you would like to restore the default behaviour later run:
 ## Testing\r
 \r
 These instructions have been tested on a clean Windows 10 machine using the\r
-[free VirtualBox image](https://dev.windows.com/en-us/microsoft-edge/tools/vms/windows/),\r
-and are also routinely tested on\r
-[Hadrian's AppVeyor CI instance](https://ci.appveyor.com/project/snowleopard/hadrian/history).\r
+[free VirtualBox image](https://dev.windows.com/en-us/microsoft-edge/tools/vms/windows/).\r
+\r
+**TODO:** It would be useful to test the instructions routinely on CI.\r
 \r
 ## Notes\r
 \r
-Beware of the [current limitations of Hadrian](https://github.com/snowleopard/hadrian#current-limitations).\r
+Beware of the [current limitations of Hadrian](https://gitlab.haskell.org/ghc/ghc/blob/master/hadrian/README.md#current-limitations).\r