Skip to content

Commit 000485e

Browse files
authored
Voice guidelines
Avoid -ing verb forms. Prefer contractions. Avoid passive verb constructions.
1 parent d8c3fad commit 000485e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/sanitizers/asan.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ Use AddressSanitizer to reduce your time spent on:
3434

3535
AddressSanitizer, originally [introduced by Google](https://www.usenix.org/conference/atc12/technical-sessions/presentation/serebryany), is a powerful alternative to both [`/RTC` (Runtime error checks)](../build/reference/rtc-run-time-error-checks.md) and [`/analyze` (Static analysis)](../build/reference/analyze-code-analysis.md). It provides run-time bug-finding technologies that use your existing build systems and existing test assets directly.
3636

37-
AddressSanitizer is integrated with the Visual Studio project system, the CMake build system, and the IDE. Projects can enable AddressSanitizer by setting a project property, or by using one extra compiler option: **`/fsanitize=address`**. The new option is compatible with all levels of optimization and configurations of x86 and x64. However, it is incompatible with [edit-and-continue](/visualstudio/debugger/edit-and-continue-visual-cpp), [incremental linking](../build/reference/incremental-link-incrementally.md), and [`/RTC`](../build/reference/rtc-run-time-error-checks.md).
37+
AddressSanitizer is integrated with the Visual Studio project system, the CMake build system, and the IDE. Projects can enable AddressSanitizer by setting a project property, or by using one extra compiler option: **`/fsanitize=address`**. The new option is compatible with all levels of optimization and configurations of x86 and x64. However, it isn't compatible with [edit-and-continue](/visualstudio/debugger/edit-and-continue-visual-cpp), [incremental linking](../build/reference/incremental-link-incrementally.md), and [`/RTC`](../build/reference/rtc-run-time-error-checks.md).
3838

3939
Starting in Visual Studio 2019 version 16.9, Microsoft's AddressSanitizer technology enables integration with the Visual Studio IDE. The functionality can optionally create a crash dump file when the sanitizer finds a bug at runtime. If you set the `ASAN_SAVE_DUMPS=MyFileName.dmp` environment variable before you run your program, a crash dump file gets created with extra metadata for efficient [post-mortem debugging](#crash-dumps) of precisely diagnosed bugs. These dump files make extended use of AddressSanitizer easier for:
4040

4141
- Local machine testing,
4242
- On-premise distributed testing, and
4343
- Cloud-based workflows for testing.
4444

45-
### Installing AddressSanitizer
45+
### Install AddressSanitizer
4646

47-
The AddressSanitizer IDE integration and libraries are installed by default with C++ workloads in the Visual Studio Installer. However, if you're upgrading from an older version of Visual Studio 2019, use the Installer to enable ASan support after the upgrade:
47+
C++ workloads in the Visual Studio Installer install AddressSanitizer IDE integration and libraries by default. However, if you're upgrading from an older version of Visual Studio 2019, use the Installer to enable ASan support after the upgrade:
4848

4949
:::image type="content" source="media/asan-installer-option.png" alt-text="Visual Studio Installer screenshot highlighting the C++ AddressSanitizer component":::
5050

@@ -55,7 +55,7 @@ You can choose **Modify** on your existing Visual Studio installation from the V
5555
>
5656
> LNK1356: cannot find library 'clang_rt.asan_dynamic-i386.lib'
5757
58-
### <a name="using-asan"></a> Using AddressSanitizer
58+
### <a name="using-asan"></a> Use AddressSanitizer
5959

6060
Start building your executables with the **`/fsanitize=address`** compiler option using any of these common development methods:
6161

@@ -65,7 +65,7 @@ Start building your executables with the **`/fsanitize=address`** compiler optio
6565

6666
Recompile, then run your program normally. This code generation exposes [many types of precisely diagnosed bugs](#error-types). These errors get reported in three ways: in the debugger IDE, on the command line, or stored in a [new type of dump file](#crash-dumps) for precise off-line processing.
6767

68-
Microsoft recommends using AddressSanitizer in these three standard workflows:
68+
Microsoft recommends you use AddressSanitizer in these three standard workflows:
6969

7070
- **Developer inner loop**
7171
- Visual Studio - [Command line](#command-prompt)
@@ -84,7 +84,7 @@ This article covers the information you require to enable the three workflows li
8484
> [!NOTE]
8585
> Current support is limited to x86 and x64 on Windows 10. [Send us feedback](https://aka.ms/vsfeedback/browsecpp) on what you'd like to see in future releases. Your feedback helps us prioritize other sanitizers for the future, such as **`/fsanitize=thread`**, **`/fsanitize=leak`**, **`/fsanitize=memory`**, **`/fsanitize=undefined`**, or **`/fsanitize=hwaddress`**. You can [report bugs here](https://aka.ms/feedback/report?space=62) if you run into issues.
8686
87-
## <a name="command-prompt"></a> Using AddressSanitizer from a developer command prompt
87+
## <a name="command-prompt"></a> Use AddressSanitizer from a developer command prompt
8888

8989
Use the **`/fsanitize=address`** compiler option in a [developer command prompt](../build/building-on-the-command-line.md#developer_command_prompt_shortcuts) to enable compiling for the AddressSanitizer runtime. The **`/fsanitize=address`** option is compatible with all existing C++ or C optimization levels (for example, `/Od`, `/O1`, `/O2`, `/O2 /GL`, and `PGO`). The option works with static and dynamic CRTs (for example, `/MD`, `/MDd`, `/MT`, and `/MTd`). It works whether you create an EXE or a DLL. Debug information is required for optimal formatting of call stacks. In the example below, `cl /fsanitize=address /Zi` is passed on the command line.
9090

@@ -126,7 +126,7 @@ Consider the overlaid, red boxes that highlight seven key pieces of information:
126126
> [!NOTE]
127127
> The function names in the call stack are produced through the [LLVM symbolizer](https://llvm.org/docs/CommandGuide/llvm-symbolizer.html) that's invoked by the runtime upon error.
128128
129-
## <a name="ide-msbuild"></a> Using AddressSanitizer in Visual Studio
129+
## <a name="ide-msbuild"></a> Use AddressSanitizer in Visual Studio
130130

131131
AddressSanitizer is integrated with the Visual Studio IDE. To turn on AddressSanitizer for an MSBuild project, right-click on the project in Solution Explorer and choose **Properties**. In the **Property Pages** dialog, select **Configuration Properties** > **C/C++** > **General**, then modify the **Enable AddressSanitizer** property. Choose **OK** to save your changes.
132132

@@ -142,7 +142,7 @@ To build and run the debugger, enter **F5**. You'll see this window in Visual St
142142

143143
:::image type="content" source="media/asan-global-buffer-overflow-F5.png" alt-text="Screenshot of the debugger showing a global buffer overflow error.":::
144144

145-
## <a name="ide-cmake"></a> Using AddressSanitizer from Visual Studio: CMake
145+
## <a name="ide-cmake"></a> Use AddressSanitizer from Visual Studio: CMake
146146

147147
To enable AddressSanitizer for [a CMake project created to target Windows](../build/cmake-projects-in-visual-studio.md), take these steps:
148148

0 commit comments

Comments
 (0)