[PATCH] D48494: [doc] Show the git config for Windows to do line-endings correctly

[Paul Robinson via Phabricator via llvm-commits]

probinson created this revision.
probinson added reviewers: rnk, hans.
Herald added a subscriber: llvm-commits.

Failing to do this before cloning causes various hassles that are easily avoided.

I thought about putting this in the getting-started-with-windows page, but it seemed better to put it right with the git info.

Should it also be listed in the mono-repo section? That's probably the more popular method now.


Repository:
  rL LLVM

https://reviews.llvm.org/D48494

Files:
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -492,8 +492,16 @@
 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
+  input`` before you clone. This goes a long way toward ensuring that
+  line-endings will be handled correctly (the LLVM project uses Linux
+  line-endings).
+
+You can do the read-only Git clone of LLVM via:
 
 .. code-block:: console
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D48494.152510.patch
Type: text/x-patch
Size: 905 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20180622/77071c0e/attachment.bin>