summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMike McLaughlin <mikem@microsoft.com>2019-05-15 17:50:35 (GMT)
committerGitHub <noreply@github.com>2019-05-15 17:50:35 (GMT)
commitbd7ca275020d61b7303ab36bbf0b06f8c7416bf7 (patch)
tree0e250c475de3d98f11071e11ea81046aad7cbcdd /Documentation
parenta836eb190e043efb05f4eeb7582806926be19b93 (diff)
downloadcoreclr-bd7ca275020d61b7303ab36bbf0b06f8c7416bf7.zip
coreclr-bd7ca275020d61b7303ab36bbf0b06f8c7416bf7.tar.gz
coreclr-bd7ca275020d61b7303ab36bbf0b06f8c7416bf7.tar.bz2
Update xplat-minidump-generation.md
Fix COMPlus_DbgMiniDumpType values
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/botr/xplat-minidump-generation.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/botr/xplat-minidump-generation.md b/Documentation/botr/xplat-minidump-generation.md
index 3c27c52..b7863e8 100644
--- a/Documentation/botr/xplat-minidump-generation.md
+++ b/Documentation/botr/xplat-minidump-generation.md
@@ -53,10 +53,20 @@ Any configuration or policy is set with environment variables which are passed a
Environment variables supported:
- `COMPlus_DbgEnableMiniDump`: if set to "1", enables this core dump generation. The default is NOT to generate a dump.
-- `COMPlus_DbgMiniDumpType`: if set to "1" generates _MiniDumpNormal_, "2" _MiniDumpWithPrivateReadWriteMemory_, "3" _MiniDumpFilterTriage_, "4" _MiniDumpWithFullMemory_. Default is _MiniDumpNormal_.
+- `COMPlus_DbgMiniDumpType`: See below. Default is "2" MiniDumpWithPrivateReadWriteMemory.
- `COMPlus_DbgMiniDumpName`: if set, use as the template to create the dump path and file name. The pid can be placed in the name with %d. The default is _/tmp/coredump.%d_.
- `COMPlus_CreateDumpDiagnostics`: if set to "1", enables the _createdump_ utilities diagnostic messages (TRACE macro).
+COMPlus_DbgMiniDumpType values:
+
+
+|Value|Minidump Enum|Description|
+|-|:----------:|----------|
+|1| MiniDumpNormal | Include just the information necessary to capture stack traces for all existing threads in a process. Limited GC heap memory and information. |
+|2| MiniDumpWithPrivateReadWriteMemory (default) | Includes the GC heaps and information necessary to capture stack traces for all existing threads in a process. |
+|3| MiniDumpFilterTriage | Include just the information necessary to capture stack traces for all existing threads in a process. Limited GC heap memory and information. |
+|4| MiniDumpWithFullMemory | Include all accessible memory in the process. The raw memory data is included at the end, so that the initial structures can be mapped directly without the raw memory information. This option can result in a very large file. |
+
(Please refer to MSDN for the meaning of the [minidump enum values](https://msdn.microsoft.com/en-us/library/windows/desktop/ms680519(v=vs.85).aspx) reported above)
**Command Line Usage**