From 8af2c60c4338c9eff468f34133067579706b0bc3 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Wed, 11 Oct 2017 16:12:06 -0700 Subject: [PATCH] Add some notes about running Cargo's tests on Windows. --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb7374ee668..5a210361fab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,6 +84,21 @@ only on `nightly` toolchain. If you can, test both toolchains. * Push your commits to GitHub and create a pull request against Cargo's `master` branch. +### Running tests on Windows + +To ensure all of Cargo's tests pass on Windows, there are a few things to +verify with your environment. Besides having a normal Rust development +environment (with CMake installed), check the following: + +* `sh` from MSYS should be in your PATH (ahead of any other `sh` installations + such as Cygwin). If you install Git for Windows, choose the option `Use Git + and optional Unix tools from the Windows Command Prompt` to use the shell + that is bundled with Git, or place the path `C:\Program Files\Git\usr\bin` + towards the top of your PATH list. +* Avoid using a `~/.cargo/config` file. Some tests run in a temp directory + within your home directory, and will inadvertently pick up any settings you + have there. + ## Pull requests After the pull request is made, a friendly bot will automatically assign a