Skip to content

Commit aa606be

Browse files
Copilotnohwnd
andcommitted
Apply PR review suggestions for environment variables documentation
Co-authored-by: nohwnd <[email protected]>
1 parent 45467fe commit aa606be

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/environment-variables.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This document lists all environment variables that are understood and handled by
4242
- **Example**: `VSTEST_HOST_DEBUG=1`
4343

4444
### VSTEST_HOST_DEBUG_ATTACHVS
45-
- **Description**: Enables debugging of the testhost process and attempts to attach Visual Studio debugger.
45+
- **Description**: Enables debugging of the testhost process and attempts to attach Visual Studio debugger. Requires AttachVS tool (that can be built in this repo) on PATH.
4646
- **Values**: Set to any non-empty value to enable
4747
- **Example**: `VSTEST_HOST_DEBUG_ATTACHVS=1`
4848

@@ -57,7 +57,7 @@ This document lists all environment variables that are understood and handled by
5757
- **Example**: `VSTEST_RUNNER_DEBUG=1`
5858

5959
### VSTEST_RUNNER_DEBUG_ATTACHVS
60-
- **Description**: Enables debugging of the test runner and attempts to attach Visual Studio debugger.
60+
- **Description**: Enables debugging of the test runner and attempts to attach Visual Studio debugger. Requires AttachVS tool (that can be built in this repo) on PATH.
6161
- **Values**: Set to any non-empty value to enable
6262
- **Example**: `VSTEST_RUNNER_DEBUG_ATTACHVS=1`
6363

@@ -87,18 +87,18 @@ This document lists all environment variables that are understood and handled by
8787
- **Example**: `VSTEST_DUMPTOOL_DEBUG=1`
8888

8989
### VSTEST_DEBUG_ATTACHVS_PATH
90-
- **Description**: Specifies the path for Visual Studio debugger attachment.
90+
- **Description**: Specifies the path for AttachVS tool, when not found on PATH. AttachVS tool can be built from this repo.
9191
- **Example**: `VSTEST_DEBUG_ATTACHVS_PATH=C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\devenv.exe`
9292

9393
### VSTEST_DEBUG_NOBP
94-
- **Description**: Disables breakpoints in debug scenarios.
94+
- **Description**: Disables breakpoints on executable entry points, to for more seemless debugging when using AttachVS.
9595
- **Values**: Set to "1" to disable breakpoints
9696
- **Example**: `VSTEST_DEBUG_NOBP=1`
9797

9898
## Crash Dump and Blame Collection Variables
9999

100100
### VSTEST_DUMP_PATH
101-
- **Description**: Overrides the default directory where crash dumps are stored.
101+
- **Description**: Overrides the default directory where crash dumps are stored. This disables automatic dump upload via attachments.
102102
- **Example**: `VSTEST_DUMP_PATH=C:\CrashDumps`
103103

104104
### VSTEST_DUMP_TEMP_PATH

0 commit comments

Comments
 (0)