bazelbuild / bazelbuild/bazel

Documentation issue: Command-Line Reference

Open
#14,766 3 comments 0 reactions 1 assignee Claimed by @michajlo View on GitHub
P2 team-Core team-Documentation type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

Documentation URL: https://docs.bazel.build/versions/main/command-line-reference.html

The documentation and behavior for the flags [`--max_test_output_bytes`](https://docs.bazel.build/versions/main/command-line-reference.html#flag--max_test_output_bytes) seems incorrect. First, it talks about impacting the size of test logs shown w/ `--test_summary` set to `errors` or `all`, but those are not parameters to `--test_summary`. AFAICT, nothing about this flag changes the output of any setting of `--test_summary`. The values match possible values for `--test_output`, maybe it should talk about that flag?

However, even with that fix it is misleading. When using `--test_output=errors`, Bazel doesn't seem to use this flag. Instead it uses `--experimental_ui_max_stdouterr_bytes` it seems, printing something like: `stdout (.../bazel-out/_tmp/actions/stdout-2) exceeds maximum size of --experimental_ui_max_stdouterr_bytes=1048576 bytes; skipping`

TBH, I'm not sure whether the last is a bug in the documentation or a bug in Bazel and it should be showing the test log rather than printing `stdout`. But at least starting off by filing as a bug in documentation.

It's also worth noting that `--max_test_output_bytes` defaults to `-1` or unlimited but the `stdouterr_bytes` doesn't.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.