mirror of
https://github.com/isar/rusqlite.git
synced 2024-11-23 00:39:20 +08:00
Document bundled-full (add contributing section)
This commit is contained in:
parent
2f9bd7ed63
commit
57749b8dbc
22
README.md
22
README.md
@ -101,7 +101,7 @@ features](https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-s
|
|||||||
* [`array`](https://sqlite.org/carray.html), The `rarray()` Table-Valued Function.
|
* [`array`](https://sqlite.org/carray.html), The `rarray()` Table-Valued Function.
|
||||||
* `i128_blob` allows storing values of type `i128` type in SQLite databases. Internally, the data is stored as a 16 byte big-endian blob, with the most significant bit flipped, which allows ordering and comparison between different blobs storing i128s to work as expected.
|
* `i128_blob` allows storing values of type `i128` type in SQLite databases. Internally, the data is stored as a 16 byte big-endian blob, with the most significant bit flipped, which allows ordering and comparison between different blobs storing i128s to work as expected.
|
||||||
* `uuid` allows storing and retrieving `Uuid` values from the [`uuid`](https://docs.rs/uuid/) crate using blobs.
|
* `uuid` allows storing and retrieving `Uuid` values from the [`uuid`](https://docs.rs/uuid/) crate using blobs.
|
||||||
* [`session`](https://sqlite.org/sessionintro.html), Session module extension.
|
* [`session`](https://sqlite.org/sessionintro.html), Session module extension. Requires `buildtime_bindgen` feature.
|
||||||
|
|
||||||
## Notes on building rusqlite and libsqlite3-sys
|
## Notes on building rusqlite and libsqlite3-sys
|
||||||
|
|
||||||
@ -166,6 +166,26 @@ enabled if you turn this on, as otherwise you'll need to keep the version of
|
|||||||
SQLite you link with in sync with what rusqlite would have bundled, (usually the
|
SQLite you link with in sync with what rusqlite would have bundled, (usually the
|
||||||
most recent release of sqlite). Failing to do this will cause a runtime error.
|
most recent release of sqlite). Failing to do this will cause a runtime error.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Rusqlite has many features, and many of them impact the build configuration in
|
||||||
|
incompatible ways. This is unfortunate, and makes testing changes hard.
|
||||||
|
|
||||||
|
To help here: you generally should ensure that you run tests/lint for
|
||||||
|
`--features bundled`, and `--features bundled-full session buildtime_bindgen`.
|
||||||
|
|
||||||
|
If running bindgen is problematic for you, `--features bundled-full` enables
|
||||||
|
bundled and all features which don't require binding generation, and can be used
|
||||||
|
instead.
|
||||||
|
|
||||||
|
### Checklist
|
||||||
|
|
||||||
|
- Run `cargo fmt` to ensure your Rust code is correctly formatted.
|
||||||
|
- Ensure `cargo clippy --all-targets --workspace --features bundled` passes without warnings.
|
||||||
|
- Ensure `cargo test --all-targets --workspace --features bundled-full session buildtime_bindgen` reports no failures.
|
||||||
|
- Ensure `cargo test --all-targets --workspace --features bundled` reports no failures.
|
||||||
|
- Ensure `cargo test --all-targets --workspace --features bundled-full session buildtime_bindgen` reports no failures.
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
|
||||||
John Gallagher, johnkgallagher@gmail.com
|
John Gallagher, johnkgallagher@gmail.com
|
||||||
|
Loading…
Reference in New Issue
Block a user