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

[Zachary Turner via llvm-commits]

I actually strongly disagree with this guidance. You should use
core.autocrlf false. A source control system should not be modifying the
content of the sources. There are some tests that specifically depend on
crlf and some that specifically depend on lf. All reasonable editors will
correctly maintain line endings, and if someone accidentally checks in crlf
line endings it’s noticed and fixed pretty quickly
On Fri, Jun 22, 2018 at 10:38 AM Paul Robinson via Phabricator <
reviews at reviews.llvm.org> wrote:

> 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 --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20180622/dafa9ca1/attachment.html>