[llvm] r335775 - Document the git config for Windows to do line-endings correctly.

[Paul Robinson via llvm-commits]

Author: probinson
Date: Wed Jun 27 12:58:28 2018
New Revision: 335775

URL: http://llvm.org/viewvc/llvm-project?rev=335775&view=rev
Log:
Document the git config for Windows to do line-endings correctly.

Differential Revision: https://reviews.llvm.org/D48494

Modified:
    llvm/trunk/docs/GettingStarted.rst

Modified: llvm/trunk/docs/GettingStarted.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=335775&r1=335774&r2=335775&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Wed Jun 27 12:58:28 2018
@@ -492,8 +492,16 @@ Git Mirror
 Git mirrors are available for a number of LLVM subprojects. These mirrors sync
 automatically with each Subversion commit and contain all necessary git-svn
 marks (so, you can recreate git-svn metadata locally). Note that right now
-mirrors reflect only ``trunk`` for each project. You can do the read-only Git
-clone of LLVM via:
+mirrors reflect only ``trunk`` for each project.
+
+.. note::
+
+  On Windows, first you will want to do ``git config --global core.autocrlf
+  false`` before you clone. This goes a long way toward ensuring that
+  line-endings will be handled correctly (the LLVM project mostly uses Linux
+  line-endings).
+
+You can do the read-only Git clone of LLVM via:
 
 .. code-block:: console