Skip to content

[Documentation] Clarify BUILD file names - #18251

Closed
saraadams wants to merge 1 commit into
bazelbuild:masterfrom
EngFlow:sara-update-build-file-docs
Closed

saraadams wants to merge 1 commit into
bazelbuild:masterfrom
EngFlow:sara-update-build-file-docs

Conversation

@saraadams

Copy link
Copy Markdown
Contributor

The documentation currently refers to BUILD files with only a small side note that the may be called BUILD.bazel, namely where packages are defined.
Instead, add a more prominent note to the page explaining BUILD files and clarify there that both namings are valid, that BUILD.bazel takes precendence, and that the documentation will talk just about BUILD files for simplicity's sake. Additionally, link to that page from the package definition section.

Progress on #4517

The documentation currently refers to `BUILD` files with only
a small side note that the may be called `BUILD.bazel`, namely
where packages are defined.
Instead, add a more prominent note to the page explaining `BUILD`
files and clarify there that both namings are valid, that
`BUILD.bazel` takes precendence, and that the documentation
will talk just about `BUILD` files for simplicity's sake.
Additionally, link to that page from the package definition section.

Progress on bazelbuild#4517
@github-actions github-actions Bot added awaiting-review PR is awaiting review from an assigned reviewer team-Documentation Documentation improvements that cannot be directly linked to other team labels labels Apr 28, 2023
@saraadams

Copy link
Copy Markdown
Contributor Author

@laurentlb I know it's been a while since you expressed you're happy to review PRs to improve the documentation regarding this. Tagging you still.

@meteorcloudy meteorcloudy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@meteorcloudy meteorcloudy added awaiting-PR-merge PR has been approved by a reviewer and is ready to be merge internally and removed awaiting-review PR is awaiting review from an assigned reviewer labels May 3, 2023
@copybara-service copybara-service Bot closed this in 60934e2 May 4, 2023
@sgowroji sgowroji removed the awaiting-PR-merge PR has been approved by a reviewer and is ready to be merge internally label May 4, 2023
fweikert pushed a commit to fweikert/bazel that referenced this pull request May 25, 2023
The documentation currently refers to `BUILD` files with only a small side note that the may be called `BUILD.bazel`, namely where packages are defined.
Instead, add a more prominent note to the page explaining `BUILD` files and clarify there that both namings are valid, that `BUILD.bazel` takes precendence, and that the documentation will talk just about `BUILD` files for simplicity's sake. Additionally, link to that page from the package definition section.

Progress on bazelbuild#4517

Closes bazelbuild#18251.

PiperOrigin-RevId: 529378158
Change-Id: If74903e0a9ffd4410a9c65c1fc9f3e5959fe83a7
@saraadams
saraadams deleted the sara-update-build-file-docs branch December 3, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team-Documentation Documentation improvements that cannot be directly linked to other team labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants