From 8e30c6e7903f0e24f0502f1e7451a0492a9944fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20B=C3=B8e?= Date: Tue, 9 Jan 2018 09:10:44 +0100 Subject: [PATCH] doc: getting_started: Improve the docs for cloning on Windows MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Explain why we set core.autocrlf=false. Signed-off-by: Sebastian Bøe --- doc/getting_started/installation_win.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/getting_started/installation_win.rst b/doc/getting_started/installation_win.rst index a20952aedf3..9859e39ef82 100644 --- a/doc/getting_started/installation_win.rst +++ b/doc/getting_started/installation_win.rst @@ -66,8 +66,13 @@ environment for Windows. Follow the steps below to set it up: $ pacman -Syu $ pacman -S git cmake make gcc dtc diffutils ncurses-devel python3 gperf -#. From within the MSYS2 MSYS Shell, clone a copy of the Zephyr source into - your home directory using Git: +#. From within the MSYS2 MSYS Shell, clone a copy of the Zephyr source + into your home directory using Git. (Some Zephyr tools require + Unix-style line endings, so we'll configure Git for this repo to + not do the automatic Unix/Windows line ending conversion (using + ``--config core.autocrlf=false``). Tools within the MSYS2 shell, + such as vim, will behave properly but Windows tools such as notepad + won't.) .. code-block:: console