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

Improve clarity of error messages / docs w.r.t. "BUILD" vs "BUILD.bazel" #17054

Open
brandjon opened this issue Dec 19, 2022 · 2 comments
Open
Labels
not stale Issues or PRs that are inactive but not considered stale P4 This is either out of scope or we don't have bandwidth to review a PR. (No assignee) team-Loading-API BUILD file and macro processing: labels, package(), visibility, glob type: feature request

Comments

@brandjon
Copy link
Member

Motivation is improving error messages like in #16207, so that users of repos that follow the "BUILD.bazel" convention aren't misled into thinking they need to create a file named "BUILD". (We also have the opposite problem within Google: We wouldn't necessarily want to direct users to create "BUILD.bazel" files when our monorepo exclusively uses "BUILD".)

We could pedantically mention "BUILD or BUILD.bazel" everywhere in errors an documentation, but that could get cumbersome and probably isn't worth its weight to the reader. Alternatively, we could just decide to only ever call them by one name or the other, and ensure the glossary or other concept documentation explains that this is an abbreviated form.

@brandjon brandjon added type: feature request P4 This is either out of scope or we don't have bandwidth to review a PR. (No assignee) team-Loading-API BUILD file and macro processing: labels, package(), visibility, glob labels Dec 19, 2022
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 Feb 23, 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 May 23, 2024
@brentleyjones brentleyjones added not stale Issues or PRs that are inactive but not considered stale and removed stale Issues or PRs that are stale (no activity for 30 days) labels May 24, 2024
@brentleyjones brentleyjones reopened this May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not stale Issues or PRs that are inactive but not considered stale P4 This is either out of scope or we don't have bandwidth to review a PR. (No assignee) team-Loading-API BUILD file and macro processing: labels, package(), visibility, glob type: feature request
Projects
None yet
Development

No branches or pull requests

2 participants