summaryrefslogtreecommitdiff
path: root/rust/README.md
diff options
context:
space:
mode:
authorAllen Webb <allenwebb@google.com>2022-01-14 16:53:54 -0600
committerCommit Bot <commit-bot@chromium.org>2022-01-19 23:35:40 +0000
commit283db281e27e89adabf40fbd8dabd4f489f083f4 (patch)
tree516e2a882e26672a51d77ac602d908aa0051b63f /rust/README.md
parentf445b236579e928354b866f7779ffb630d15311c (diff)
downloadvboot-stabilize-14469.41.B.tar.gz
This adds Rust bindings to vboot_reference. BRANCH=none BUG=b:214081328 TEST=cargo build Change-Id: I4f9df36a0de93c0617ead2a75ef2ca5fcf8f5652 Signed-off-by: Allen Webb <allenwebb@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/vboot_reference/+/3390514 Reviewed-by: Mike Frysinger <vapier@chromium.org>
Diffstat (limited to 'rust/README.md')
-rw-r--r--rust/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/rust/README.md b/rust/README.md
new file mode 100644
index 00000000..3a899cef
--- /dev/null
+++ b/rust/README.md
@@ -0,0 +1,18 @@
+# Rust bindings for vboot_reference
+
+This path contains the vboot_reference-sys crate which uses bindgen to generate
+Rust bindings for the vboot_reference C library.
+
+Each header is included as its own submodule. To use these bindings:
+ * Add `vboot_reference-sys` to your `Cargo.toml` for example:
+```toml
+[dependencies]
+vboot_reference-sys = { path = "../../vboot_reference/rust/vboot_reference-sys" }
+```
+ * Include the symbols you need for example:
+```rust
+use vboot_reference_sys::crossystem::*;
+```
+
+The `build.rs` in `vboot_reference-sys` takes care of adding the necessary
+includes and linker flags for `vboot_host` through the `pkg-config` crate.