@@ -10,7 +10,7 @@ APIs in Rust match the APIs defined in C.
1010
1111## MSRV (Minimum Supported Rust Version)
1212
13- The MSRV is 1.63 .0 because of the transitive dependencies.
13+ The MSRV is 1.88 .0 because of the transitive dependencies.
1414Note that MSRV may be changed anytime by dependencies.
1515
1616## Example
@@ -34,7 +34,7 @@ mylib-sys = { path = "../mylib-sys" }
3434libc = " 0.2"
3535
3636[build-dependencies ]
37- ctest = " 0.4 "
37+ ctest = " 0.5.0-beta.0 "
3838```
3939
4040Next, add a build script to ` systest/build.rs ` :
@@ -52,7 +52,7 @@ fn main() {
5252
5353 // Generate the tests, passing the path to the `*-sys` library as well as
5454 // the module to generate.
55- cfg . generate ( " ../mylib-sys/lib.rs" , " all.rs" );
55+ ctest :: generate_test ( & mut cfg , " ../mylib-sys/lib.rs" , " all.rs" );
5656}
5757```
5858
@@ -72,10 +72,10 @@ directory, and everything should be kicked into action!
7272
7373## How it works
7474
75- This library will parse the ` *-sys ` crate to learn about all extern fn
76- definitions within. It will then generate a test suite to ensure that all
77- function function signatures, constant values, struct layout/alignment, type
78- size/alignment, etc, all match their C equivalent.
75+ This library will parse the ` *-sys ` crate to learn about all definitions within.
76+ It will then generate a test suite to ensure that all function signatures,
77+ constant values, struct layout/alignment, type size/alignment, etc,
78+ all match their C equivalent.
7979
8080The generated tests come in two forms. One is a Rust file which contains the
8181` main ` function (hence the ` include! ` above), and another is a C file which is
@@ -101,6 +101,14 @@ This project is licensed under either of
101101
102102at your option.
103103
104+ ## Modifying test templates
105+ If you modify the test templates for either Rust or C in any way, then before
106+ contributing you must run the following command to update the pre-generated test
107+ files we check against:
108+ ``` rust
109+ $ LIBC_BLESS = 1 cargo test
110+ ```
111+
104112## Contribution
105113
106114Unless you explicitly state otherwise, any contribution intentionally submitted
0 commit comments