| commit | 4dd1b9ba1629c2836f5b0cb3daf630783e205953 | [log] [tgz] |
|---|---|---|
| author | lberki <lberki@users.noreply.github.com> | Fri Apr 21 15:20:54 2023 +0200 |
| committer | GitHub <noreply@github.com> | Fri Apr 21 15:20:54 2023 +0200 |
| tree | f0dcf0f107cf6b6efdee61eb6acc81fcb3045ee6 | |
| parent | 7c4dcb72f3e23643b5517543771a7e54e3b24896 [diff] |
Update README.md Co-authored-by: Yun Peng <pcloudy@google.com>
This repository houses all canonical constraint_setting()s, constraint_value()s and platform()s that are universally useful across languages and Bazel projects.
For questions or concerns please email bazel-discuss@googlegroups.com.
Constraints must be carefully organized to avoid fragmentation. If two different declarations for, say, cpu=x86_64 were to exist at the same time then select() statements and toolchain selection would stop working across languages and projects.
This repository only includes truly ubiquitous constraints.
Most common constraints -- that is settings and values that can be used across projects - fall into specific areas like “Apple” or “Java”. These are declared in those areas' respective repositories.
A very few constraints (such as OS and cpu) are relevant for essentially all projects across all areas. These are what this repository is for.
To add a new canonical constraint value, prepare a PR adding it to that the appropriate BUILD file.
Note that even global constraint values are typically area values. For example, ios is an area value for the global setting os but belongs in the apple area. For the PR's reviewer(s) choose an owner of this repository plus an owner of the area repository this references..
A constraint value should be:
semantically clear, particularly in its distinctions from other values of the same setting
well-named: consistent with existing values of the same setting and easy to understand at usage sites
well-documented
Remember that this value will apply for the entire Bazel community and its semantics will be difficult to impossible to change once it starts being used.
New canonical constraint settings should be rare and well-justified.
To add a new setting, prepare a design document according to Bazel's design review process. This document should explain the need for a new setting and why it belongs here vs. area-specific repositories. It should clearly explain semantics, initial values, and criteria for adding new values.
Once the design is approved prepare a PR for the actual change. If any values are area-specific, include the area repositories' owners as reviewers.
If you‘d like to experiment with changes to global settings or values, you can fork this repo for experimental purposes. But in the interest of community health and interoperability please don’t share your changes with anyone not involved with the experiment. For wider distribution, submit a proper change here.
Note that you can declare constraint_values in your own repo that are members of the global constraint_settings. This lets you “extend” global settings within the confines of your own project. But don't do this if you expect other projects to use these changes - this can easily lead to fragmentation conflicts.
If you need custom constaint_settings, just declare them in your own repo. They are, by definition, not global.
If you really need a permanent global change and it isn't design-approved for this repo, start a thread on GitHub to discuss options.