bazelbuild/bazel

The `label_flag`, `label_setting` rules have no reference documentation

Open

#16,128 opened on Aug 18, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3good first issuehelp wantedteam-Configurabilityteam-Documentationtype: documentation (cleanup)

Repository metrics

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

Description

Description of the bug:

The label_flag and label_setting built-in rules are discussed in https://bazel.build/extending/config#label-typed-build-settings, but have no reference documentation listing their attributes. It should probably be documented at https://bazel.build/reference/be/general. Only by searching around the internet for code examples did I find, for example, that the label_flag rule has a help attribute!

The situation is even more dire with label_setting, because there is no example code showing how one might use it.

What's the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.

No response

Which operating system are you running Bazel on?

No response

What is the output of bazel info release?

No response

If bazel info release returns development version or (@non-git), tell us how you built Bazel.

No response

What's the output of git remote get-url origin; git rev-parse master; git rev-parse HEAD ?

No response

Have you found anything relevant by searching the web?

No response

Any other information, logs, or outputs that you want to share?

No response

Contributor guide

Research direction
Locate the documentation source files for Bazel build rules (likely in the site/ directory of the repository) and add reference documentation for label flag and label setting, including attributes like 'help'.
Tech stack
java
Domain
build systemdocumentation
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
Bazel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80