From: Reid Kleckner Date: Tue, 27 Nov 2018 03:55:15 +0000 (+0000) Subject: [docs] UBSan and ASan are supported on Windows X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=48602926c3083fe303bb6ffc2cacb55e79731c1f;p=clang [docs] UBSan and ASan are supported on Windows Also fix a bullet list. Fixes PR39775 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@347633 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/AddressSanitizer.rst b/docs/AddressSanitizer.rst index 066b13b2ab..020acbcc50 100644 --- a/docs/AddressSanitizer.rst +++ b/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/docs/UndefinedBehaviorSanitizer.rst b/docs/UndefinedBehaviorSanitizer.rst index 156a9dfa64..ddffee85c9 100644 --- a/docs/UndefinedBehaviorSanitizer.rst +++ b/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``