diff options
| author | Reid Kleckner <rnk@google.com> | 2018-11-27 03:55:15 +0000 |
|---|---|---|
| committer | Reid Kleckner <rnk@google.com> | 2018-11-27 03:55:15 +0000 |
| commit | 0bbbc55182b5579654c2b563079fd6fbd29731aa (patch) | |
| tree | db6778277344d598cec1f195a7e254a096a5ddf0 /clang/docs | |
| parent | 4325505f051f910160193a71f56612a9dcde0358 (diff) | |
[docs] UBSan and ASan are supported on Windows
Also fix a bullet list.
Fixes PR39775
llvm-svn: 347633
Diffstat (limited to 'clang/docs')
| -rw-r--r-- | clang/docs/AddressSanitizer.rst | 4 | ||||
| -rw-r--r-- | clang/docs/UndefinedBehaviorSanitizer.rst | 8 |
2 files changed, 11 insertions, 1 deletions
diff --git a/clang/docs/AddressSanitizer.rst b/clang/docs/AddressSanitizer.rst index 066b13b2ab6c..020acbcc50d3 100644 --- a/clang/docs/AddressSanitizer.rst +++ b/clang/docs/AddressSanitizer.rst @@ -278,6 +278,7 @@ AddressSanitizer is supported on: * Android ARM * NetBSD i386/x86\_64 * FreeBSD i386/x86\_64 (tested on FreeBSD 11-current) +* Windows 8.1+ (i386/x86\_64) Ports to various other platforms are in progress. @@ -288,6 +289,9 @@ AddressSanitizer is fully functional on supported platforms starting from LLVM 3.1. The test suite is integrated into CMake build and can be run with ``make check-asan`` command. +The Windows port is functional and is used by Chrome and Firefox, but it is not +as well supported as the other ports. + More Information ================ diff --git a/clang/docs/UndefinedBehaviorSanitizer.rst b/clang/docs/UndefinedBehaviorSanitizer.rst index 156a9dfa6450..ddffee85c98d 100644 --- a/clang/docs/UndefinedBehaviorSanitizer.rst +++ b/clang/docs/UndefinedBehaviorSanitizer.rst @@ -288,7 +288,7 @@ There are several limitations: Supported Platforms =================== -UndefinedBehaviorSanitizer is supported on the following OS: +UndefinedBehaviorSanitizer is supported on the following operating systems: * Android * Linux @@ -296,6 +296,11 @@ UndefinedBehaviorSanitizer is supported on the following OS: * FreeBSD * OpenBSD * OS X 10.6 onwards +* Windows + +The runtime library is relatively portable and platform independent. If the OS +you need is not listed above, UndefinedBehaviorSanitizer may already work for +it, or could be made to work with a minor porting effort. Current Status ============== @@ -318,6 +323,7 @@ Example ------- For a file called ``/code/library/file.cpp``, here is what would be emitted: + * Default (No flag, or ``-fsanitize-undefined-strip-path-components=0``): ``/code/library/file.cpp`` * ``-fsanitize-undefined-strip-path-components=1``: ``code/library/file.cpp`` * ``-fsanitize-undefined-strip-path-components=2``: ``library/file.cpp`` |