Add a core dump example.
authorSantiago Fernandez Madero <safern@microsoft.com>
Tue, 21 Nov 2017 00:10:57 +0000 (16:10 -0800)
committerGitHub <noreply@github.com>
Tue, 21 Nov 2017 00:10:57 +0000 (16:10 -0800)
Documentation/building/debugging-instructions.md

index 838a15b..b50be43 100644 (file)
@@ -149,15 +149,22 @@ It is also possible to debug .NET Core crash dumps using lldb and SOS. In order
 Once you have everything listed above, you are ready to start debugging. You need to specify an extra parameter to lldb in order for it to correctly resolve the symbols for libcoreclr.so. Use a command like this:
 
 ```
-lldb-3.9 -O "settings set target.exec-search-paths <runtime-path>" --core <core-file-path> <host-path>
+lldb-3.9 -O "settings set target.exec-search-paths <runtime-path>" -o “plugin load <path-to-libsosplugin.so>” --core <core-file-path> <host-path>
 ```
 
 - `<runtime-path>`: The path containing libcoreclr.so.dbg, as well as the rest of the runtime and framework assemblies.
 - `<core-file-path>`: The path to the core dump you are attempting to debug.
 - `<host-path>`: The path to the dotnet or corerun executable, potentially in the `<runtime-path>` folder.
+- `<path-to-libsosplugin.so>`: The path to libsosplugin.so, should be in the `<runtime-path>` folder.
 
 lldb should start debugging successfully at this point. You should see stacktraces with resolved symbols for libcoreclr.so. At this point, you can run `plugin load <libsosplugin.so-path>`, and begin using SOS commands, as above.
 
+##### Example
+
+```
+lldb-3.9 -O "settings set target.exec-search-paths /home/parallels/Downloads/System.Drawing.Common.Tests/home/helixbot/dotnetbuild/work/2a74cf82-3018-4e08-9e9a-744bb492869e/Payload/shared/Microsoft.NETCore.App/9.9.9/" -o "plugin load /home/parallels/Downloads/System.Drawing.Common.Tests/home/helixbot/dotnetbuild/work/2a74cf82-3018-4e08-9e9a-744bb492869e/Payload/shared/Microsoft.NETCore.App/9.9.9/libsosplugin.so" --core /home/parallels/Downloads/System.Drawing.Common.Tests/home/helixbot/dotnetbuild/work/2a74cf82-3018-4e08-9e9a-744bb492869e/Work/f6414a62-9b41-4144-baed-756321e3e075/Unzip/core /home/parallels/Downloads/System.Drawing.Common.Tests/home/helixbot/dotnetbuild/work/2a74cf82-3018-4e08-9e9a-744bb492869e/Payload/shared/Microsoft.NETCore.App/9.9.9/dotnet
+```
+
 Using Visual Studio Code
 ========================