summaryrefslogtreecommitdiffstats
path: root/tests/depfile/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/depfile/Readme.md')
-rw-r--r--tests/depfile/Readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/tests/depfile/Readme.md b/tests/depfile/Readme.md
new file mode 100644
index 0000000..d7f8b1a
--- /dev/null
+++ b/tests/depfile/Readme.md
@@ -0,0 +1,11 @@
+This a folder containing tests for `--depfile` parameter.
+Each test is in a subfolder and defines a minimum CMake project,
+which uses cbindgen to generate Rust bindings and the `--depfile`
+parameter to determine when to regenerate.
+The outer test can the build the project, assert that rebuilding does not regenerate the
+bindings, and then assert that touching the files involved does trigger rebuilding.
+
+The test project must contain an `expectations` folder, containing a file `dependencies`.
+This `dependencies` should list all files that should be listed as dependencies in the generated
+depfile. The paths should be relative to the project folder (i.e. to the folder containing
+`expectations`).