Clean up confusing wording in ASan documentation (#453)

This commit is contained in:
Brodie Robertson 2024-02-01 22:47:33 +10:30 committed by GitHub
parent 2c3e4725c6
commit 352e83b231
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -53,7 +53,7 @@ recommended to do in tty
clone wayland (`git clone --recursive https://gitlab.freedesktop.org/wayland/wayland`) clone wayland (`git clone --recursive https://gitlab.freedesktop.org/wayland/wayland`)
clone hyprland (`git clone --recursive https://github.com/hyprwm/Hyprland`) clone hyprland (`git clone --recursive https://github.com/hyprwm/Hyprland`)
add these envs to reset ASAN_OPTIONS for children and set LD_PRELOAD: add these envs to your Hyprland config to reset ASAN_OPTIONS for children and set LD_PRELOAD:
``` ```
env = ASAN_OPTIONS,detect_odr_violation=0 env = ASAN_OPTIONS,detect_odr_violation=0
env = LD_PRELOAD,/usr/lib/libasan.so.8.0.0 env = LD_PRELOAD,/usr/lib/libasan.so.8.0.0
@ -66,6 +66,9 @@ meson ./build --prefix=/usr --buildtype=debug -Db_sanitize=address
sudo ninja -C build install sudo ninja -C build install
``` ```
The Wayland build will likely fail citing missing dependencies such as Doxygen, these
dependencies will likely be available from your distros package manager.
hyprland: hyprland:
``` ```
cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Debug -DWITH_ASAN:STRING=True -S . -B ./build -G Ninja cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Debug -DWITH_ASAN:STRING=True -S . -B ./build -G Ninja