summaryrefslogtreecommitdiffstats
path: root/llvm/docs
diff options
context:
space:
mode:
authorPaul Robinson <paul.robinson@sony.com>2018-06-27 19:58:28 +0000
committerPaul Robinson <paul.robinson@sony.com>2018-06-27 19:58:28 +0000
commitbc0748e81230a5230d8dfbf0b4ef06dafe3c2434 (patch)
treec486cbe47ec8078a33a73f93863bb85d9a11c7ed /llvm/docs
parent02151cacca5c99e406da2c2ddaddc8adce432bb6 (diff)
downloadbcm5719-llvm-bc0748e81230a5230d8dfbf0b4ef06dafe3c2434.tar.gz
bcm5719-llvm-bc0748e81230a5230d8dfbf0b4ef06dafe3c2434.zip
Document the git config for Windows to do line-endings correctly.
Differential Revision: https://reviews.llvm.org/D48494 llvm-svn: 335775
Diffstat (limited to 'llvm/docs')
-rw-r--r--llvm/docs/GettingStarted.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index b26df141b86..7cfd67ce715 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -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
OpenPOWER on IntegriCloud