diff --git a/BUILDING.md b/BUILDING.md index 7af12f40bd33a7..6a6bf24194ce88 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -29,7 +29,7 @@ file a new issue. * [Running Coverage](#running-coverage) * [Building the documentation](#building-the-documentation) * [Building a debug build](#building-a-debug-build) - * [Building an ASAN build](#building-an-asan-build) + * [Building an ASan build](#building-an-asan-build) * [Speeding up frequent rebuilds when developing](#speeding-up-frequent-rebuilds-when-developing) * [Troubleshooting Unix and macOS builds](#troubleshooting-unix-and-macos-builds) * [Windows](#windows) @@ -507,16 +507,16 @@ $ gdb /opt/node-debug/node core.node.8.1535359906 $ backtrace ``` -#### Building an ASAN build +#### Building an ASan build -[ASAN](https://github.com/google/sanitizers) can help detect various memory -related bugs. ASAN builds are currently only supported on linux. +[ASan](https://github.com/google/sanitizers) can help detect various memory +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`). The `--debug` is not necessary and will slow down build and testing, but it can -show clear stacktrace if ASAN hits an issue. +show clear stacktrace if ASan hits an issue. ```console $ ./configure --debug --enable-asan && make -j4