Skip to content

doc,build,win: update docs with clang #57991

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

StefanStojanovic
Copy link
Contributor

This PR changes the documentation to fit the new compiler on Windows - ClangCL. The main focus is the BUILDING.md file. All three Windows Prerequisites sections are updated to reflect the compiler change (WinGet configuration already supported it, so no changes there).

In addition, there are changes to vcbuild.bat to add the clang-cl flag for Node.js v24+ even if not provided. Since v24 will include #57753 (or some other V8 update), compiling with MSVC will result in errors, so IMHO, there is not much use in allowing MSVC compilation at all, although I'm open to suggestions and different opinions on this.

Updated BUILDING.md to make ClangCL mandatory for new versions of Node.
Forcing clang-cl flag in vcbuild if not specified, thus disabling MSVC.
@StefanStojanovic StefanStojanovic added doc Issues and PRs related to the documentations. windows Issues and PRs related to the Windows platform. build Issues and PRs related to build files or the CI. labels Apr 23, 2025
@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. labels Apr 23, 2025
@richardlau richardlau added dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. labels Apr 23, 2025
Copy link
Member

@joyeecheung joyeecheung left a comment

Choose a reason for hiding this comment

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

LGTM % a suggestion to the log, I think just saying it's mandatory might make people unfamiliar with the process think that they need to do something to make it work when they see the log, even though it's purely informative.

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
@joyeecheung joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 24, 2025
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 24, 2025
@nodejs-github-bot
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants