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.

Sign up for GitHub

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

Jump to bottom

Improve configurability documentation #11967

Open
6 tasks
gregestren opened this issue Aug 18, 2020 · 3 comments
Open
6 tasks

Improve configurability documentation #11967

gregestren opened this issue Aug 18, 2020 · 3 comments
Labels
P2 We'll consider working on this in future. (Assignee optional) 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

@gregestren
Copy link
Contributor

gregestren commented Aug 18, 2020 •
edited
Loading

Spawned from #5574 (comment).

Specific ideas:
@gregestren gregestren added P2 We'll consider working on this in future. (Assignee optional) team-Configurability platforms, toolchains, cquery, select(), config transitions type: documentation (cleanup) labels Aug 18, 2020
@gregestren
Copy link
Contributor Author

gregestren commented Aug 18, 2020 •
edited
Loading

Also review reference docs:

@gregestren
Copy link
Contributor Author

Also:

  • clarify difference between cfg = "exec" and cfg = "host"

@gregestren gregestren mentioned this issue Aug 20, 2020
Closed
@gregestren
Copy link
Contributor Author

Also: beautify error messages.

katre added a commit to katre/bazel that referenced this issue Aug 21, 2020
@katre
Update configuration docs to discuss the exec and host configurations…
a4d1dfc 
…, and how they are different and similar.

Part of improving configurability documentation, bazelbuild#11967.
This was referenced Aug 21, 2020
Merged
Closed
katre added a commit to bazelbuild/examples that referenced this issue Aug 21, 2020
@katre
Update examples to use an exec transition instead of host. (#183)
b29794f 
Part of improving configurability documentation,
bazelbuild/bazel#11967.
bazel-io pushed a commit that referenced this issue Aug 25, 2020
@katre @copybara-github
Update configuration docs to discuss the exec and host configurations…
f9edc07 
…, and how they are different and similar.

Part of improving configurability documentation, #11967.

Closes #11991.

PiperOrigin-RevId: 328330191
bazel-io pushed a commit that referenced this issue Aug 25, 2020
@gregestren @copybara-github
Refresh configurable attributes doc.
8e8dcc8 
Highlights:

- Update outdated "Starlark flags not yet supported" refs
- Convert "--define" examples to Starlark flags when possible
- Overhaul "native vs. user-defined" core config_setting description
- Use more consistent package naming for examples
- Remove "Short keys" section, which is considered bad practice (creates too much indirection which makes it hard to know what relies on what).

For #11967

PiperOrigin-RevId: 328335077
@keertk keertk added the team-Documentation Documentation improvements that cannot be directly linked to other team labels label Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P2 We'll consider working on this in future. (Assignee optional) 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
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gregestren @keertk