Skip to content

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

Open
MohamedRady-99 wants to merge 1 commit into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix-readme-bazel-instructions
Open

docs: update README build and profiling instructions to use Bazel#110
MohamedRady-99 wants to merge 1 commit into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix-readme-bazel-instructions

Conversation

@MohamedRady-99

Copy link
Copy Markdown
Contributor

This PR resolves the issue with outdated README documentation by updating the build and profiling instructions to use Bazel instead of Cargo #70.

Since cargo build is no longer supported in this repository, and some previously referenced examples (like hello_tracing) do not have Bazel targets, the documentation has been rewritten to ensure all commands are fully functional with the current build system.

Proposal:

Currently, the documentation instructs users to build and profile using cargo and unsupported targets. This PR updates the workflow as follows:

  1. Update Build Instructions: Remove mentions of cargo build in the Rust setup section, pointing users exclusively to bazel.
  2. Fix CPU Profiling (Samply): Replace the unsupported hello_tracing example with the working mini-adas target (//examples/rust/mini-adas:adas_primary_com_iox2_direct_unix) and update the binary execution paths to use bazel-bin/.
  3. Fix Memory Profiling (Bytehound): Change the LD_PRELOAD recording commands to execute the Bazel-built mini-adas binary instead of the old Cargo target/debug/ paths, and update the expected output .dat filenames in the analysis section.

Thanks!

Change-Id: I735139d7dac6cb9087af54057a9a72697b61d97f
@github-actions

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
2026/06/15 11:09:01 Downloading https://github.com/aspect-build/aspect-cli/releases/download/5.9.36/bazel-5.9.36-linux-x86_64...
2026/06/15 11:09:02 Downloading https://releases.bazel.build/8.3.0/release/bazel-8.3.0-linux-x86_64...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 687fd377-19f0-459a-955e-8faf2fc44749
Computing main repo mapping: 
Computing main repo mapping: 
DEBUG: Rule 'rules_boost+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-LTilyiMMjpYyAi1PW+8RycyAEHy9clo7915R0Bchb2E="
DEBUG: Repository rules_boost+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:394:31: in <toplevel>
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_bazel_platforms', the root module requires module version score_bazel_platforms@0.1.1, but got score_bazel_platforms@0.1.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'googletest', the root module requires module version googletest@1.17.0, but got googletest@1.17.0.bcr.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 4 packages loaded
Loading: 4 packages loaded
    currently loading: 
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/feo/feo/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/feo/feo/BUILD
INFO: Elapsed time: 9.172s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@anmittag

Copy link
Copy Markdown
Member

any updates on the PR @MohamedRady-99 or shall we close the PR by August, 31st

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants