summaryrefslogtreecommitdiffstats
path: root/third_party/rust/pin-project/DEVELOPMENT.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/pin-project/DEVELOPMENT.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/pin-project/DEVELOPMENT.md')
-rw-r--r--third_party/rust/pin-project/DEVELOPMENT.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/third_party/rust/pin-project/DEVELOPMENT.md b/third_party/rust/pin-project/DEVELOPMENT.md
new file mode 100644
index 0000000000..2e5cb4e435
--- /dev/null
+++ b/third_party/rust/pin-project/DEVELOPMENT.md
@@ -0,0 +1,46 @@
+# Development Guide
+
+## Testing
+
+To run all tests, run the following command:
+
+```sh
+cargo +nightly test --all
+```
+
+### UI tests (`tests/ui`, `tests/compiletest.rs`)
+
+This checks errors detected by the macro or the Rust compiler in the resulting
+expanded code.
+
+To run this test, run the following command:
+
+```sh
+cargo +nightly test --test compiletest
+```
+
+Locally, this test updates the files in the `ui` directory if there are
+changes to the generated code. If there are any changes to the files in the
+`ui` directory after running the test, please commit them.
+
+See also [`trybuild` documentation](https://docs.rs/trybuild).
+
+### Expansion tests (`tests/expand`, `tests/expandtest.rs`)
+
+Similar to ui tests, but instead of checking the compiler output, this checks
+the code generated by macros.
+
+See [examples](examples/README.md) for descriptions of what the generated
+code does, and why it needs to be generated.
+
+To run this test, run the following command:
+
+```sh
+cargo +nightly test --test expandtest
+```
+
+Locally, this test updates the files in the `expand` directory if there are
+changes to the generated code. If there are any changes to the files in the
+`expand` directory after running the test, please commit them.
+
+See also [`macrotest` documentation](https://docs.rs/macrotest).