Skip to content

BUILDING.md

Latest commit

 

History

History
69 lines (51 loc) · 2.01 KB

BUILDING.md

File metadata and controls

69 lines (51 loc) · 2.01 KB

Building Pulse

Initialize submodules

git submodule update --init --recursive

Install dependencies

  • Install Rust. The project does not currently have a Minimum Supported Rust Version (MSRV). We may use features from the latest Rust stable releases as soon as they are released. If you are seeing Rust build failures first perform rustup update.
  • (Optional) Install Protobuf. Using the package manager of your choice should be fine if you like.
  • (Optional) Install Flatbuffers. Using the package manager of your choice should be fine if you like. Note that Pulse does not currently use flatbuffers but when performing a complete compile bd-proto in shared-core will require this as that crate is also used in the Capture SDK.
  • Note that on Linux the cargo config assumes that lld is available as the linker in order to improve linking speed.

Building

For all build steps, specifying SKIP_PROTO_GEN=1 will use the checked in generated proto files and will not require protoc and flatc to be available. If not specifying this environment variable the optional protoc and flatc dependencies specified above must be available.

To build all binaries:

cargo build

To run all tests:

cargo test

To build just the proxy binary:

cargo build --bin pulse-proxy

To develop and run at the same time:

pulse> cargo run --bin pulse-proxy -- --help
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.37s
     Running `target/debug/pulse-proxy --help`
Usage: pulse-proxy [OPTIONS] --config <CONFIG>

Options:
  -c, --config <CONFIG>
      --config-check-and-exit
      --version
      --shutdown-delay <SHUTDOWN_DELAY>  [default: 0]
  -h, --help                             Print help

Release binaries

Make sure to compile with the optimizing compiler as is done in the Docker builds.

cargo build --release