]> granicus.if.org Git - clang/commitdiff
[docs] UBSan and ASan are supported on Windows
authorReid Kleckner <rnk@google.com>
Tue, 27 Nov 2018 03:55:15 +0000 (03:55 +0000)
committerReid Kleckner <rnk@google.com>
Tue, 27 Nov 2018 03:55:15 +0000 (03:55 +0000)
Also fix a bullet list.

Fixes PR39775

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@347633 91177308-0d34-0410-b5e6-96231b3b80d8

docs/AddressSanitizer.rst
docs/UndefinedBehaviorSanitizer.rst

index 066b13b2ab6c68ce4af6e5624b69851aa5811e11..020acbcc50d397fa43d6c9a4633e3ae206d1d99e 100644 (file)
@@ -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
 ================
 
index 156a9dfa64509bcd38a8af79cce080d67015dde6..ddffee85c98d9e6ab77a479019129d217788a975 100644 (file)
@@ -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``