From ed77e4e69cf654c028fce5a19bd2e2ee983f764d Mon Sep 17 00:00:00 2001 From: Ed Morley Date: Tue, 11 Aug 2015 12:30:38 +0100 Subject: [PATCH] Bug 1178300 - Docs: Add Windows-specific setup help Fixes #684. --- docs/installation.rst | 1 + docs/troubleshooting.rst | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index 6f2caeb38..1375a8a3f 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -7,6 +7,7 @@ Prerequisites * If you are new to Mozilla or the A-Team, read the `A-Team Bootcamp`_. * Install Git_, Virtualbox_ and Vagrant_ 1.5+ (recent versions recommended). * Clone the `treeherder repo`_ from Github. +* Windows only: Ensure MSYS ssh (ships with Git for Windows) is on the PATH, so Vagrant can find it (using PuTTY is more hassle). Setting up Vagrant ------------------ diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 1dd713fa7..a0b6fd378 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -33,6 +33,14 @@ Errors during Vagrant setup .. _guide: http://www.sysprobs.com/disable-enable-virtualization-technology-bios +* On Windows, if upon running ``vagrant ssh`` you see the error *"/home/vagrant/.bash_aliases: line 1: syntax error near unexpected token `$'{\r''"* - it means your global Git line endings configuration is not correct. On the host machine run: + + .. code-block:: bash + + git config --global core.autocrlf input + + You will then need to delete and reclone the repo (or else do a force checkout). + Using supervisord for development ---------------------------------