From bc0748e81230a5230d8dfbf0b4ef06dafe3c2434 Mon Sep 17 00:00:00 2001 From: Paul Robinson Date: Wed, 27 Jun 2018 19:58:28 +0000 Subject: [PATCH] Document the git config for Windows to do line-endings correctly. Differential Revision: https://reviews.llvm.org/D48494 llvm-svn: 335775 --- llvm/docs/GettingStarted.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index b26df141b86f..7cfd67ce7157 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 -- GitLab