bazelbuild / bazelbuild/bazel

Command line reference should clarify which flags can be used in a transition

Open
#18,675 0 comments 0 reactions 0 assignees View on GitHub
P2 team-Configurability team-Documentation type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Page link:

https://bazel.build/reference/command-line-reference

### Problem description (include actual vs expected text, if applicable):

The list of flags fails to communicate which flags are part of the [build configuration](https://cs.opensource.google/bazel/bazel/+/master:src/main/java/com/google/devtools/build/lib/analysis/config/BuildConfigurationValue.java) (because they are part of a [configuration fragment](https://cs.opensource.google/bazel/bazel/+/master:src/main/java/com/google/devtools/build/lib/analysis/config/FragmentOptions.java)) and which are not. This makes it unclear to users what can be [changed in a configuration transition](https://bazel.build/extending/config#user-defined-transitions).

### Where do you see this issue? (include link to specific section of the page, if applicable)

_No response_

### Any other information you'd like to share?

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the command-line reference page and compare its flag list with BuildConfigurationValue.java and FragmentOptions.java, then read the user-defined transitions documentation. Determine how the reference should distinguish flags belonging to configuration fragments from those that do not. Done means the page clearly indicates which flags can be changed in a configuration transition.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.