Skip to content

Commit ce89591

Browse files
SpriteOvOAmanieu
authored andcommitted
Recommend using run-docker.sh instead of run.sh in CONTRIBUTING.md
1 parent 1f3b4ef commit ce89591

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ to improve the documentation of `stdarch`!
7070

7171
# Alternative Testing Instructions
7272

73-
It is generally recommended that you use `ci/run.sh` to run the tests.
73+
It is generally recommended that you use `ci/run-docker.sh` to run the tests.
7474
However this might not work for you, e.g. if you are on Windows.
7575

7676
In that case you can fall back to running `cargo +nightly test` and `cargo +nightly test --release -p core_arch` for testing the code generation.
@@ -79,7 +79,7 @@ In particular you need to set the `TARGET` environment variable as you would for
7979
In addition you need to set `RUSTCFLAGS` (need the `C`) to indicate target features, e.g. `RUSTCFLAGS="-C -target-features=+avx2"`.
8080
You can also set `-C -target-cpu=native` if you're "just" developing against your current CPU.
8181

82-
Be warned that when you use these alternative instructions, [things may go less smoothly than they would with `ci/run.sh`][ci-run-good], e.g. instruction generation tests may fail because the disassembler named them differently, e.g. it may generate `vaesenc` instead of `aesenc` instructions despite them behaving the same.
82+
Be warned that when you use these alternative instructions, [things may go less smoothly than they would with `ci/run-docker.sh`][ci-run-good], e.g. instruction generation tests may fail because the disassembler named them differently, e.g. it may generate `vaesenc` instead of `aesenc` instructions despite them behaving the same.
8383
Also these instructions execute less tests than would normally be done, so don't be surprised that when you eventually pull-request some errors may show up for tests not covered here.
8484

8585

0 commit comments

Comments
 (0)