diff options
| author | Cindy Lin <cinlin@google.com> | 2023-10-11 17:15:05 -0700 |
|---|---|---|
| committer | Boringssl LUCI CQ <boringssl-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-10-12 15:42:38 +0000 |
| commit | 55715e36ef14efea573b62d853849e06dbad04d6 (patch) | |
| tree | 9d1d5e70f1a2d63c744246ef8a16e4b933f4371a /rust | |
| parent | 26d84fdf024cf85e461aa10b59f9484699167533 (diff) | |
| download | boringssl-55715e36ef14efea573b62d853849e06dbad04d6.zip boringssl-55715e36ef14efea573b62d853849e06dbad04d6.tar.gz boringssl-55715e36ef14efea573b62d853849e06dbad04d6.tar.bz2 | |
Edit bssl-sys setup instructions.
Change-Id: I764551f842361b455f122287bcf7c4aef4b5cb82
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/63546
Auto-Submit: Cindy Lin <cinlin@google.com>
Reviewed-by: David Benjamin <davidben@google.com>
Commit-Queue: David Benjamin <davidben@google.com>
Diffstat (limited to 'rust')
| -rw-r--r-- | rust/bssl-sys/README.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/rust/bssl-sys/README.md b/rust/bssl-sys/README.md index e2efd6c..c988813 100644 --- a/rust/bssl-sys/README.md +++ b/rust/bssl-sys/README.md @@ -7,6 +7,8 @@ A low-level binding crate for Rust that moves in lockstop with BoringSSL. Boring `bssl-sys` uses `bindgen` as part of the cmake build process to generate Rust compatibility shims for the targeted platform. It is important to generate it for the correct platform because `bindgen` uses LLVM information for alignment which varies depending on architecture. ### To Use -Build `boringssl` with `-DRUST_BINDINGS=<rust-triple>` and ensure that you have `bindgen` installed. The `rust-triple` option should match the [Rust target triple](https://doc.rust-lang.org/nightly/rustc/platform-support.html) when building `bssl-sys`. +1. Build `boringssl` with `-DRUST_BINDINGS=<rust-triple>`, which should match the [Rust target triple](https://doc.rust-lang.org/nightly/rustc/platform-support.html) when building `bssl-sys`, +2. install `bindgen`, and +3. install [`cargo-deny`](https://github.com/EmbarkStudios/cargo-deny). -From there, the `bssl-sys` crate can be built. By default, it looks for `bindgen` output and BoringSSL static libraries in the `build` directory. This can be reconfigured with `BORINGSSL_BUILD_DIR` environment variable. Note the environment variable is evaluated relative to `rust/bssl-sys/src`, so using an absolute path may be more convenient. +After that, the `bssl-sys` crate can be built. By default, it looks for `bindgen` output and BoringSSL static libraries in the `build` directory. This can be reconfigured with `BORINGSSL_BUILD_DIR` environment variable. Note the environment variable is evaluated relative to `rust/bssl-sys/src`, so using an absolute path may be more convenient. |