bazelbuild / bazelbuild/bazel

Documentation issue: Command-Line Reference

Open
#13,326 1 comment 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-ExternalDeps 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/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

Open the contributing guide

Research direction

Start with the --workspace_status_command entry in the command-line reference at the documented URL, then inspect tools/buildstamp/get_workspace_status and the references to the User's Manual mentioned there. Done means the example's interaction is explained and the ambiguous manual reference is identified or corrected in the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.