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

configuration_field needs a warning not to use and a link to an example of using build settings #11309

Open
laurentlb opened this issue May 6, 2020 · 6 comments
Labels
help wanted Someone outside the Bazel team could own this P3 We're not considering working on this, but happy to review a PR. (No assignee) team-Configurability platforms, toolchains, cquery, select(), config transitions team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup)

Comments

@laurentlb
Copy link
Contributor

https://docs.bazel.build/versions/3.1.0/skylark/lib/globals.html#configuration_field

We need a longer example of use. It should be put in https://github.com/bazelbuild/examples/tree/master/rules with a link in the documentation (so that we can easily test and maintain the snippet).

@brandjon brandjon self-assigned this May 11, 2020
@laurentlb laurentlb added team-Configurability platforms, toolchains, cquery, select(), config transitions and removed team-Front-End labels May 19, 2020
@katre
Copy link
Member

katre commented May 20, 2020

@gregestren: Do we want to keep this available? I'd argue that we don't want to document it, as we don't want people using it.

@laurentlb
Copy link
Contributor Author

Alternatively: document that you don't want people to use it

@juliexxia
Copy link
Contributor

Yeah, this should be replaced by people using label-typed build settings: https://docs.google.com/document/d/1vc8v-kXjvgZOdQdnxPTaV0rrLxtP2XwnD2tAZlYJOqw/edit?pli=1#bookmark=id.22i50t6u7ub7

I think the TODOs here are really to deprecate configuration_field and add a link to an example about how to use label-typed build settings instead. Not sure if I have the bandwidth to deprecate configuration_field right at this second but can add an warning/example as part of my example sweep from the fixit.

@juliexxia juliexxia assigned juliexxia and unassigned brandjon May 26, 2020
@juliexxia juliexxia added P2 We'll consider working on this in future. (Assignee optional) and removed untriaged labels May 26, 2020
@juliexxia juliexxia changed the title configuration_field needs longer example configuration_field needs a warning not to use and a link to an example of using build settings May 26, 2020
@juliexxia
Copy link
Contributor

I changed the name to reflect! Let me know if that direction doesn't seem right.

@juliexxia
Copy link
Contributor

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

Yes this should still happen. Label-typed build settings should be able to deprecate configuration field since they fulfill the same purpose. Here's an e2e example of using label-typed build settings, it can probably be amended briefly to document an equivalent configuration_field so folks have an easy before and after

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

keertk commented Jan 18, 2023

Docs moved here

@keertk keertk added P3 We're not considering working on this, but happy to review a PR. (No assignee) help wanted Someone outside the Bazel team could own this and removed P2 We'll consider working on this in future. (Assignee optional) labels Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Someone outside the Bazel team could own this P3 We're not considering working on this, but happy to review a PR. (No assignee) team-Configurability platforms, toolchains, cquery, select(), config transitions 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

6 participants