[commit: ghc] wip/nfs-locking: Added a note about git line-ending settings (#303) (295c781)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : wip/nfs-locking
Link       : http://ghc.haskell.org/trac/ghc/changeset/295c7812ab8fe8e34e6812127e039220a850a344/ghc

>---------------------------------------------------------------

commit 295c7812ab8fe8e34e6812127e039220a850a344
Author: Ivan Poliakov <ivan.poliakov at ncl.ac.uk>
Date:   Fri Mar 31 23:54:46 2017 +0100

    Added a note about git line-ending settings (#303)


>---------------------------------------------------------------

295c7812ab8fe8e34e6812127e039220a850a344
 doc/windows.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/windows.md b/doc/windows.md
index 73804df..510b986 100644
--- a/doc/windows.md
+++ b/doc/windows.md
@@ -5,6 +5,14 @@
 Here is how you can build GHC, from source, on Windows. We assume that `git` and `stack` are
 installed (see [prerequisites](https://github.com/snowleopard/hadrian/blob/master/doc/windows.md#prerequisites)).
 
+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:
+
+    git config --global core.autocrlf false
+    
+If you would like to restore the default behaviour later run:
+
+    git config --global core.autocrlf true
+
 ```sh
 # Get GHC and Hadrian sources
 git clone --recursive git://git.haskell.org/ghc.git