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 default value and possible values for --experimental_build_event_upload_strategy #23789

Open
mortenmj opened this issue Sep 27, 2024 · 2 comments
Labels
team-Core Skyframe, bazel query, BEP, options parsing, bazelrc team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup) untriaged

Comments

@mortenmj
Copy link

mortenmj commented Sep 27, 2024

Page link:

https://bazel.build/reference/command-line-reference

Problem description (include actual vs expected text, if applicable):

Currently the documentation for the default value says "default: see description", but the default is not explained in the description. There is also no list of legal values for this flag, which makes it hard to know what values can be set.
The description of the flag could also be expanded a bit, to better communicate what this is for.

Where do you see this issue? (include link to specific section of the page, if applicable)

https://bazel.build/reference/command-line-reference#flag--experimental_build_event_upload_strategy

Any other information you'd like to share?

No response

@mortenmj mortenmj added team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup) untriaged labels Sep 27, 2024
@iancha1992 iancha1992 added the team-CLI Console UI label Sep 27, 2024
@jin
Copy link
Member

jin commented Oct 1, 2024

@michaeledgar (from blame)

@jin jin added team-Core Skyframe, bazel query, BEP, options parsing, bazelrc and removed team-CLI Console UI labels Oct 1, 2024
@michaeledgar
Copy link
Contributor

(Back from baby bonding leave) I've sent a CL to document this. While we wait for it to go through review, I can share my first draft of the new help string:

"Selects how to upload artifacts referenced in the build event protocol. In Bazel the valid options include 'local' and 'remote'. The default value is 'local'."

(This option takes an additional value in Blaze. This is likely why the docstring was left so bare-bones before.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-Core Skyframe, bazel query, BEP, options parsing, bazelrc team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup) untriaged
Projects
None yet
Development

No branches or pull requests

6 participants