bazelbuild / bazelbuild/bazel

Documentation issue: Debugging remote cache hits for remote execution

Open
#12,770 0 comments 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-Remote-Exec type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

Documentation URL: https://docs.bazel.build/versions/master/remote-execution-caching-debug.html

This piece of documentation still references the old flag [`--execution_log_binary_file`][binary] which requires additional steps to build a parser in the Bazel source tree and convert the binary files into a human readable format. Is there a reason why this guide does not reference the new flag [`--execution_log_json_file`][json] which produces human readable JSON output right away? An additional benefit to JSON output would be that it is easier to manipulate with tools like `jq`.

[binary]: https://docs.bazel.build/versions/3.7.0/command-line-reference.html#flag--execution_log_binary_file
[json]: https://docs.bazel.build/versions/3.7.0/command-line-reference.html#flag--execution_log_json_file

Contributor guide

Open the contributing guide

Research direction

Open the documentation URL and inspect the debugging guide's references to --execution_log_binary_file and --execution_log_json_file. Verify the linked command-line references and jq workflow; done means the guide accurately explains the human-readable JSON approach and its links remain valid.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.