Skip to content

Commit 7727b99

Browse files
authored
Add backticks in "AddressSanitizer runtime" topic
1 parent 4167c4c commit 7727b99

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/sanitizers/asan-runtime.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ The AddressSanitizer runtime library intercepts common memory allocation functio
1111

1212
When compiling with `cl /fsanitize=address`, the compiler generates instructions to manage and check [shadow bytes](./asan-shadow-bytes.md). Your program uses this instrumentation to check memory accesses on the stack, in the heap, or in the global scope. The compiler also produces metadata describing stack and global variables. This metadata enables the runtime to generate precise error diagnostics: function names, lines, and columns in your source code. Combined, the compiler checks and runtime libraries can precisely diagnose many types of [memory safety bugs](./asan-error-examples.md) if they're encountered at run-time.
1313

14-
The list of runtime libraries for linking to the AddressSanitizer runtime, as of Visual Studio 17.7 Preview 3, follows. For more information about the `/MT` (statically link the runtime) and `/MD` (dynamically link the redist at runtime) options, see [/MD, /MT, /LD (Use Run-Time Library)](../build/reference/md-mt-ld-use-run-time-library.md).
14+
The list of runtime libraries for linking to the AddressSanitizer runtime, as of Visual Studio 17.7 Preview 3, follows. For more information about the `/MT` (statically link the runtime) and `/MD` (dynamically link the redist at runtime) options, see [`/MD`, `/MT`, `/LD` (Use Run-Time Library)](../build/reference/md-mt-ld-use-run-time-library.md).
1515

1616
> [!NOTE]
1717
> In the following table, *`{arch}`* is either *`i386`* or *`x86_64`*.
1818
> These libraries use Clang conventions for architecture names. MSVC conventions are normally `x86` and `x64` rather than `i386` and `x86_64`, but they refer to the same architectures.
1919
20-
| CRT option | AddressSanitizer runtime library (.lib) | Address runtime binary (.dll)
20+
| CRT option | AddressSanitizer runtime library (`.lib`) | Address runtime binary (`.dll`)
2121
|--|--|--|
2222
| `/MT` or `/MTd` | *`clang_rt.asan_dynamic-{arch}`*, *`clang_rt.asan_static_runtime_thunk-{arch}`* | *`clang_rt.asan_dynamic-{arch}`*
2323
| `/MD` or `/MDd` | *`clang_rt.asan_dynamic-{arch}`*, *`clang_rt.asan_dynamic_runtime_thunk-{arch}`* | *`clang_rt.asan_dynamic-{arch}`*
@@ -130,8 +130,8 @@ extern "C" const char* __asan_default_options()
130130

131131
### Unsupported AddressSanitizer options
132132

133-
- detect_container_overflow
134-
- unmap_shadow_on_exit
133+
- `detect_container_overflow`
134+
- `unmap_shadow_on_exit`
135135

136136
> [!NOTE]
137137
> The AddressSanitizer runtime option `halt_on_error` doesn't function the way you might expect. In both the Clang and the MSVC runtime libraries, many error types are considered **non-continuable**, including most memory corruption errors.
@@ -152,9 +152,9 @@ For more information, see the [Differences with Clang 12.0](asan.md#differences)
152152
- If set to `"ignore"`, the runtime doesn't attempt to correct any overwritten functions and proceeds with execution.
153153

154154
- `windows_fast_fail_on_error`
155-
Boolean (false by default), set to `true` to enable the process to terminate with a __fastfail(71) after printing the error report.
155+
Boolean (`false` by default), set to `true` to enable the process to terminate with a `__fastfail(71)` after printing the error report.
156156
>[!NOTE]
157-
>When abort_on_error value is set to true, on Windows the program terminates with an exit(3). In order to not change current behavior we decided to introduce this new option instead. If both abort_on_error and windows_fast_fail_on_error are true, the program will exit with the __fastfail.
157+
>When `abort_on_error` value is set to `true`, on Windows the program terminates with an `exit(3)`. In order to not change current behavior we decided to introduce this new option instead. If both `abort_on_error` and `windows_fast_fail_on_error` are `true`, the program will exit with the `__fastfail`.
158158
159159
- `windows_hook_legacy_allocators`
160160
Boolean, set to `false` to disable interception of [`GlobalAlloc`](/windows/win32/api/winbase/nf-winbase-globalalloc) and [`LocalAlloc`](/windows/win32/api/winbase/nf-winbase-localalloc) allocators.

0 commit comments

Comments
 (0)