From 231bccbc9be95be1db53a26d759cba2bfa55e951 Mon Sep 17 00:00:00 2001 From: Nick Fitzgerald Date: Tue, 5 Sep 2017 09:59:01 -0700 Subject: Note that we need `rustfmt` to run tests now --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d56ff777..7703188f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,6 +96,14 @@ There is also the `./bindgen-integration` crate, which uses `bindgen` to generate bindings to some C++ code, and then uses the bindings, asserting that values are what we expect them to be both on the Rust and C++ side. +The generated and expected bindings are run through `rustfmt` before they are +compared. Make sure you have `rustfmt` up to date: + +``` +$ rustup update nightly +$ rustup run nightly cargo install -f rustfmt-nightly +``` + ### Testing Bindings Generation To regenerate bindings from the corpus of test headers in `tests/headers` and -- cgit v1.2.3