Skip to content

Commit

Permalink
Fix grammar issues in devdocs/sanitizers.md (JuliaLang#43600)
Browse files Browse the repository at this point in the history
  • Loading branch information
garrison committed Jan 4, 2022
1 parent b4b75f0 commit 9bf289e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/src/devdocs/sanitizers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## General considerations

Using Clang's sanitizers obviously require you to use Clang (`USECLANG=1`), but there's another
Using Clang's sanitizers obviously requires you to use Clang (`USECLANG=1`), but there's another
catch: most sanitizers require a run-time library, provided by the host compiler, while the instrumented
code generated by Julia's JIT relies on functionality from that library. This implies that the
LLVM version of your host compiler matches that of the LLVM library used within Julia.
LLVM version of your host compiler must match that of the LLVM library used within Julia.

An easy solution is to have an dedicated build folder for providing a matching toolchain, by building
An easy solution is to have a dedicated build folder for providing a matching toolchain, by building
with `BUILD_LLVM_CLANG=1`. You can then refer to this toolchain from another build
folder by specifying `USECLANG=1` while overriding the `CC` and `CXX` variables.

Expand Down Expand Up @@ -39,7 +39,7 @@ For detecting or debugging memory bugs, you can use Clang's [address sanitizer (
By compiling with `SANITIZE_ADDRESS=1` you enable ASAN for the Julia compiler and its generated code.
In addition, you can specify `LLVM_SANITIZE=1` to sanitize the LLVM library as well. Note that
these options incur a high performance and memory cost. For example, using ASAN for Julia and
LLVM makes `testall1` takes 8-10 times as long while using 20 times as much memory (this can be
LLVM makes `testall1` take 8-10 times as long while using 20 times as much memory (this can be
reduced to respectively a factor of 3 and 4 by using the options described below).

By default, Julia sets the `allow_user_segv_handler=1` ASAN flag, which is required for signal
Expand Down

0 comments on commit 9bf289e

Please sign in to comment.