bazelbuild/bazel

Documentation issue: Command-Line Reference

Open

#13,326 opened on Apr 11, 2021

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

Repository metrics

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

Description

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

The entry for --workspace_status_command says: A command invoked at the beginning of the build to provide status information about the workspace in the form of key/value pairs. See the User's Manual for the full specification. Also see tools/buildstamp/get_workspace_status for an example.

Two problems:

  1. the example is not explaining how it interacts with --workspace_status_command
  2. This "manual", what is it? It's definitely not https://docs.bazel.build/versions/4.0.0/command-line-reference.html, and there is no other "manual" anywhere else in the docs.bazel.build hierarchy!

Contributor guide

Research direction
Fix the documentation by updating the link to the User's Manual and clarifying how the example interacts with workspace status command.
Tech stack
java
Domain
documentationbuild 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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
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.
90