GeezerVison

A few suggestions:

1. Instead of suggesting to build on docker Windows and Mac, we should make sure our config works on those operating systems. Especially on Mac using docker can be really slow since it runs on a VM (well, it also runs on a VM on Windows, but with HyperV it's a bit faster). Not only that, if we use docker we'll never have ASAN checking Windows and Mac specific code paths
2. Also add instructions to build with clang
3. --debug is not required. We can suggest debug build in the paragraph and explain why it's useful, but the first example command shouldn't have it because it's a lot slower to build and to run tests
4. --ninja is not our official build tool and is not required for ASAN, therefore it shouldn't be here as well (folks who prefer Ninja probably already know the option exist). Maybe mention that building with ninja also works
5. With the suggestions above we can use make test-only instead of executing the tests manually. Calling tools/test.py will miss cctest for example, so it's better to keep it simple and follow our current build workflow

Instead of suggesting to build on docker Windows and Mac, we should make sure our config works on those operating systems.

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).

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 doesn’t need a full CI run, but the commit message should start with doc:.

This doesn’t need a full CI run, but the commit message should start with doc:.

Should I just run this one https://ci.nodejs.org/job/node-test-linter/ ?

In this case just Actions is fine (since it's a doc-only change)

Landed in 9c00af0

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)

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 ?