:lipstick: Correct the command's spelling/name. (#1711)
authorPure Krome <github@world-domination.com.au>
Wed, 11 Nov 2020 02:21:39 +0000 (13:21 +1100)
committerGitHub <noreply@github.com>
Wed, 11 Nov 2020 02:21:39 +0000 (18:21 -0800)
The command is `dotnet-dump` so I thought it might be appropriate to make sure the docs are correctly referring to the strict spelling/name of the command. Otherwise, I thought it was actually `dotnet` (the dotnet command) and then `dump` (the tool) ... where the tool is really `dotnet-dump`

documentation/dotnet-dump-instructions.md

index 41361276ec6e3c41dea7da53fe1c2793d0cbf297..7aa14b51a08f30e535849fc9ebd446708047ba2e 100644 (file)
@@ -5,11 +5,11 @@ The dotnet-dump CLI global tool is way to collect and analyze the managed data s
 
 Here's a table showing how dotnet-dump fits into your dump debugging options:
 
-|                        | Windows native dumps | Windows managed eg from `dotnet dump collect` | Linux system dump | Linux from `dotnet dump collect` | macOS system dump | macOS from `dotnet dump collect` |
+|                        | Windows native dumps | Windows managed eg from `dotnet-dump collect` | Linux system dump | Linux from `dotnet-dump collect` | macOS system dump | macOS from `dotnet-dump collect` |
 |:-----------------------|:---------------------|:----------------------------------------------|:------------------|:---------------------------------|:------------------|:---------------------------------|
 | Visual Studio          | yes                  | yes                                           | yes (1)           | yes (1)                          | no, need lldb     | no                               |
 | Windbg (including SOS) | yes                  | yes                                           | yes (2)           | yes (2)                          | no, need lldb     | no                               |
-| `dotnet dump analyze`  | no                   | yes                                           | no                | yes                              | no                | yes                              |
+| `dotnet-dump analyze`  | no                   | yes                                           | no                | yes                              | no                | yes                              |
 
 (1) [Requires Visual Studio 2019 version 16.8 Preview 3](https://devblogs.microsoft.com/cppblog/debug-linux-core-dumps-in-visual-studio/) or later.
 (2) [Requires WinDbg Preview version 1.0.2007.01003](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/windbg-what-is-new-preview) or later.
@@ -31,7 +31,7 @@ If this is the first global tool installed or you get message `Could not execute
 
 The next step is to collect a dump. This can be skipped if a core dump has already been generated by the operating system or [createdump](https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/xplat-minidump-generation.md#configurationpolicy) on Linux. The default dump type (--type option) is currently "full".
 
-On Linux, the .NET runtime version must be 3.0 or greater. On Windows, `dotnet dump collect` will work with any version of the .NET runtime.
+On Linux, the .NET runtime version must be 3.0 or greater. On Windows, `dotnet-dump collect` will work with any version of the .NET runtime.
      
     $ dotnet-dump collect --process-id 1902
     Writing minidump to file ./core_20190226_135837