bazelbuild/bazel

Document Bazel's terminal output, particularly action statistics

Open

#11,068 opened on Apr 4, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-OSStype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

The Bazel terminal output reports statistics about build/test progress in a variety of ways that can be confusing for users. See, e.g., this bazel-discuss thread for some examples. We should document what the statistics mean, along with pointers to the command line options that can be used to customize the output.

Contributor guide

Research direction
Read the bazel discuss thread referenced in the issue, look at the Bazel source code for terminal output formatting, and examine the command line options for customizing output (e.g., show progress rate limit, progress report interval). Then produce documentation explaining the statistics and how to tailor the output.
Tech stack
java
Domain
clideveloper experiencebuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85