-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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
doc: add ASAN build instructions #32436
Conversation
A few suggestions:
|
On windows ASAN only support cmake IIRC. macOS is also broken for our repo. on Container it should cover most cases. But I agree it would be much better we check on those platforms too. So if anyone want to help with the asan issue on windows and macOS, it's the fastest way (I am using docker even on linux). |
BUILDING.md
Outdated
related bugs. ASAN builds are currently only supported on linux. | ||
If you want to check it on Windows or macOS or you want a consistent toolchain | ||
on Linux, you can try [Docker](https://www.docker.com/products/docker-desktop) | ||
(using an image like `gengjiawen/node-build:2020-02-14`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing .
at the end of the sentence.
Oh right, I almost forgot: before we land it, should we add instructions on how to build with clang (since ASAN works generally better with clang)? $ CC=clang CXX=clang++ LINK=clang++ ./configure --debug --enable-asan
$ CC=clang CXX=clang++ LINK=clang++ make -j4
$ CC=clang CXX=clang++ LINK=clang++ make test-only Or, if the user is using the docker container: $ docker run -e CC=clang -e CXX=clang++ -e LINK=clang++ ... (not a blocker, but I had better results with clang) |
This comment has been minimized.
This comment has been minimized.
This doesn’t need a full CI run, but the commit message should start with |
Should I just run this one |
In this case just Actions is fine (since it's a doc-only change) |
PR-URL: #32436 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Landed in 9c00af0 |
Good point, the new docker image now is set to clang by default. Also we should make that use clang in general build and mention in ASAN part clang has better output ? |
PR-URL: #32436 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me>
PR-URL: #32436 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me>
PR-URL: #32436 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes