search

bazelbuild / bazel

a fast, scalable, multi-language and extensible build system
https://bazel.build
Apache License 2.0
23.23k stars 4.07k forks source link

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

Open brandjon opened 1 year ago

brandjon commented 1 year ago

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.

github-actions[bot] commented 8 months ago

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[bot] commented 5 months ago

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!