diff options
| author | Franz Dietrich <dietrich@teilgedanken.de> | 2024-04-04 00:01:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-03 22:01:46 +0000 |
| commit | 53ed7bf7edb21180cb18c0bf6a7dbe6168331879 (patch) | |
| tree | e7b86edf26aa3bfcf6af4dd825d67a627e8c1252 /CONTRIBUTING.md | |
| parent | fa2a5b449f1746b4b3bb3da08dab532ee24ba286 (diff) | |
fix included examples and markdown(book) (#912)
* fix included examples and markdown(book)
fixes: #911
* fix footnote pre_init
* more example link updates
* Restore pool example name
* Example: pool: Upgrade to heapless v0.8
* Example: pool: thumbv6 unsupported: wild cfg-if
Experiment with multi-backend example contained in the example
* Example: lm3s6965: Updated cargo.lock
* Book: Use cargo xtask for by-example
* Docs: Contributing: cargo xtask
---------
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c6a861..a027e26 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,30 +36,23 @@ Please make sure that tests passes locally before submitting. ### Example check ```shell -> cargo check --examples --target thumbv7m-none-eabi +> cargo xtask example-check ``` -and/or +### Run examples/tests on QEMU device ```shell -> cargo check --examples --target thumbv6m-none-eabi +> cargo xtask qemu ``` -### Run tests with xtask +Will execute examples on your local `qemu` install. -```shell -> cargo xtask --target all -``` - -Will execute `run` tests on your local `qemu` install. -(You may also pass a single target `--target thumbv6m-none-eabi/thumbv7m-none-eabi` during development). - -#### Adding tests to xtask +#### Adding examples/tests to xtask If you have added further tests, you need to add the expected output in the `ci/expected` folder. ```shell -> cargo run --example <NAME> --target thumbv7m-none-eabi > ci/expected/<NAME>.run +> cargo xtask qemu --overwrite-expected ``` ### Internal tests @@ -67,7 +60,7 @@ If you have added further tests, you need to add the expected output in the `ci/ Run internal fail tests locally with: ```shell -> cargo test --tests +> cargo xtask test ``` #### Adding tests to internal tests @@ -76,7 +69,7 @@ If you have added fail tests or changed the expected behavior, the expected outp Inspect the error output, when sure that `ACTUAL OUTPUT` is correct you can re-run the test as: ```shell -> TRYBUILD=overwrite cargo test --tests +> TRYBUILD=overwrite cargo xtask test ``` This will update the expected output to match the `ACTUAL OUTPUT`. |