Skip to content

Commit 143aa62

Browse files
committed
further edit of top level for M1
1 parent ca7d5c0 commit 143aa62

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/cpp/ASAN/asan-top-level.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ helpviewer_keywords: ["ASan","sanitizers","AddressSanitizer","clang_rt.asan","Cl
88

99
# Address Sanitizer
1010

11-
# Overview
11+
## Overview
1212

1313
The C & C++ languages are powerful, but they can suffer from different types of bugs which affect program correctness and program security. Starting with Visual Studio 2019 16.9, the Microsoft Visual C++ compiler and IDE support Address Sanitizer technology to help light up [hard-to-find bugs](#error-types) with zero false positives.
1414

@@ -24,22 +24,20 @@ The Address Sanitizer is a compiler and runtime runtime [introduced by Google](h
2424

2525
Compiling with `-fsanitize=address` is a powerful alternative to both [/RTC](https://docs.microsoft.com/en-us/cpp/build/reference/rtc-run-time-error-checks?view=msvc-160), and [/analyze](https://docs.microsoft.com/en-us/cpp/code-quality/code-analysis-for-c-cpp-overview?view=msvc-160). It provides run-time bug-finding technologies which leverage your existing build systems and existing test assets.
2626

27-
For CI/CD systems and Cloud based work flows, use the ASAN_SAVE_DUMPS environment variable to store crash dumps for post-mortem debugging specific to the Address Sanitizer.
28-
29-
By setting a new environment variable via **`set ASAN_SAVE_DUMPS=”MyFileName.dmpx”`** your program will create a new type of dump file that will contain extra meta-data. These dump files can be displayed with Visual Studio using the new debugger IDE. These dump files can be an enabler for work flows requiring:
27+
By setting a new environment variable via **`set ASAN_SAVE_DUMPS=”MyFileName.dmpx”`** your program will create a new type of crash dump file that will contain extra meta-data for post-mortem debugging. These dump files can be displayed off-line, with Visual Studio's new debugger IDE. These dump files can be an enabler for work flows requiring:
3028

3129
- On-premises testing
3230
- Cloud based workflows for testing
3331

34-
These systems can store these dump files off line, with **precisely diagnosed bugs** which can be viewed against your source code, in the IDE.
32+
These test systems can store the dump files, with **precisely diagnosed bugs**, for later viewing super imposed on your source code in the IDE.
3533

36-
## Installing the Address Sanitizer
34+
### Installing the Address Sanitizer
3735

3836
Simply [**install the Address Sanitizer functionality**]().
3937

4038
After installing and building your executables with the `-fsanitize=address`compiler switch on the command line, Vusual Studio project system or cmake integration, you simply run your program normally. THis will light up [many types of bugs](#errors) in the debugger IDE, on the command line or be stored in a new type of dump file.
4139

42-
## Using the Address Sanitizer
40+
### Using the Address Sanitizer
4341

4442
Microsoft recommends using the Address Sanitizer in these **three standard workflows**:
4543

0 commit comments

Comments
 (0)