Skip to content

docs: update README build and profiling instructions to use Bazel #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MohamedRady-99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update README build and profiling instructions to use Bazel #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ cd feo

## Rust setup

You can build the Rust code both with `bazel` and with `cargo`.
The CI will run both builds and ensure neither one is broken.
You can build the Rust code with `bazel`.

### Bazel specific commands

Expand Down Expand Up @@ -50,7 +49,7 @@ bazel query //...
Run example rust binary

```sh
bazel run //examples/rust/mini-adas:adas_primary
bazel run //examples/rust/mini-adas:adas_primary_com_iox2_direct_unix
```

[bazelisk]: https://github.com/bazelbuild/bazelisk
Expand All @@ -70,8 +69,8 @@ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/mstange/samply/releases
Profile:

```sh
cargo build --example hello_tracing --profile profiling
samply record target/profiling/examples/hello_tracing
bazel build -c opt //examples/rust/mini-adas:adas_primary_com_iox2_direct_unix
samply record bazel-bin/examples/rust/mini-adas/adas_primary_com_iox2_direct_unix
# ...
# <ctrl-c>
```
Expand All @@ -96,7 +95,8 @@ mv bytehound libbytehound.so $HOME/.cargo/bin
Record something with bytehound:

```sh
LD_PRELOAD=$HOME/.cargo/bin/libbytehound.so target/debug/examples/hello_tracing
bazel build //examples/rust/mini-adas:adas_primary_com_iox2_direct_unix
LD_PRELOAD=$HOME/.cargo/bin/libbytehound.so bazel-bin/examples/rust/mini-adas/adas_primary_com_iox2_direct_unix
# ...
# <ctrl-c>
```
Expand Down
Loading