Minor revision
authorAndrey Mokhov <andrey.mokhov@gmail.com>
Thu, 5 Oct 2017 16:58:20 +0000 (17:58 +0100)
committerGitHub <noreply@github.com>
Thu, 5 Oct 2017 16:58:20 +0000 (17:58 +0100)
doc/windows.md

index f644f03..b374074 100644 (file)
@@ -2,19 +2,11 @@
 \r
 [![Windows status](https://img.shields.io/appveyor/ci/snowleopard/hadrian/master.svg?label=Windows)](https://ci.appveyor.com/project/snowleopard/hadrian)\r
 \r
-Here is how you can build GHC, from source, on Windows. We assume that `git` and `stack` are\r
-installed (see [prerequisites](https://github.com/snowleopard/hadrian/blob/master/doc/windows.md#prerequisites)).\r
-\r
-Note that `git` should be configured to check out Unix-style line endings. The default behaviour of `git` on Windows is to check out Windows-style line endings which can cause issues during the build. This can be changed using the following command:\r
-\r
-    git config --global core.autocrlf false\r
-\r
-If you would like to restore the default behaviour later run:\r
-\r
-    git config --global core.autocrlf true\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\r
+# Get GHC and Hadrian 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
@@ -55,6 +47,16 @@ The above works on a clean machine with `git` and `stack` installed (tested with
 installation settings), which you can get from 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
+\r
+    git config --global core.autocrlf false\r
+\r
+If you would like to restore the default behaviour later run:\r
+\r
+    git config --global core.autocrlf true\r
+\r
 ## Testing\r
 \r
 These instructions have been tested on a clean Windows 10 machine using the\r
@@ -65,4 +67,3 @@ and are also routinely tested on
 ## Notes\r
 \r
 Beware of the [current limitations of Hadrian](https://github.com/snowleopard/hadrian#current-limitations).\r
-\r