Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document configuration transitions #8377

Closed
laurentlb opened this issue May 17, 2019 · 3 comments
Closed

Document configuration transitions #8377

laurentlb opened this issue May 17, 2019 · 3 comments
Labels
P3 We're not considering working on this, but happy to review a PR. (No assignee) stale Issues or PRs that are stale (no activity for 30 days) team-Configurability Issues for Configurability team team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup)

Comments

@laurentlb
Copy link
Contributor

Documentation of the cfg argument in rule is unclear (https://docs.bazel.build/versions/0.25.0/skylark/lib/globals.html#rule):

If set, points to the configuration transition the rule will apply to its own configuration before analysis.

I don't think a user will be able to understand and use that.

Rules documentation doesn't mention it either (https://docs.bazel.build/versions/master/skylark/rules.html). The Example repository (https://github.com/bazelbuild/examples/tree/master/rules) also doesn't help.

@juliexxia juliexxia self-assigned this May 20, 2019
bazel-io pushed a commit that referenced this issue May 20, 2019
…her starlark docs.

Re: #8377

RELNOTES: None.
PiperOrigin-RevId: 249066782
irengrig pushed a commit to irengrig/bazel that referenced this issue Jun 18, 2019
…her starlark docs.

Re: bazelbuild#8377

RELNOTES: None.
PiperOrigin-RevId: 249066782
@aiuto aiuto added the P3 We're not considering working on this, but happy to review a PR. (No assignee) label Oct 30, 2020
@juliexxia
Copy link
Contributor

juliexxia commented Feb 4, 2021

(Context: I'm moving on from Bazel on friday and spending some time triaging all bugs assigned to me before unassigning myself)

This is still a confusing thing. cfg should be documented for both the rule() function (which can only be a starlark transition) and the attr.label/_list() functions (which can be an unfortunately wide variety of things).

@juliexxia juliexxia removed their assignment Feb 4, 2021
@sgowroji sgowroji added the team-Documentation Documentation improvements that cannot be directly linked to other team labels label Jan 11, 2023
Copy link

Thank you for contributing to the Bazel repository! This issue has been marked as stale since it has not had any activity in the last 1+ years. It will be closed in the next 90 days unless any other activity occurs. If you think this issue is still relevant and should stay open, please post any comment here and the issue will no longer be marked as stale.

@github-actions github-actions bot added the stale Issues or PRs that are stale (no activity for 30 days) label Mar 17, 2024
Copy link

This issue has been automatically closed due to inactivity. If you're still interested in pursuing this, please post @bazelbuild/triage in a comment here and we'll take a look. Thanks!

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 We're not considering working on this, but happy to review a PR. (No assignee) stale Issues or PRs that are stale (no activity for 30 days) team-Configurability Issues for Configurability team team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup)
Projects
None yet
Development

No branches or pull requests

4 participants