summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Fitzgerald <fitzgen@gmail.com>2017-09-05 09:59:01 -0700
committerNick Fitzgerald <fitzgen@gmail.com>2017-09-07 10:52:31 -0700
commit231bccbc9be95be1db53a26d759cba2bfa55e951 (patch)
treecd10343bab3a55e7c0e18de571c81aa22f5c7725
parentcca40374e9dd75975ec247243efa6628d6d5d0f4 (diff)
Note that we need `rustfmt` to run tests now
-rw-r--r--CONTRIBUTING.md8
1 files changed, 8 insertions, 0 deletions
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