Skip to content

Commit

Permalink
Preview5 doc update. (#225) (#226)
Browse files Browse the repository at this point in the history
Add Release notes for dotnet-dump.

Remove --add-source in installation instructions.
  • Loading branch information
mikem8361 authored Apr 30, 2019
1 parent e0f78e4 commit 4936a8c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
10 changes: 9 additions & 1 deletion documentation/dotnet-dump-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The dotnet-dump CLI global tool is way to collect and analyze Windows and Linux

The first step is to install the dotnet-dump CLI global tool. This requires the 2.1 .NET Core SDK to be installed. If you see the error message `Tool 'dotnet-dump' is already installed`, you will need to uninstall the global tool (see below).

$ dotnet tool install -g dotnet-dump --version 1.0.3-preview5.19228.1 --add-source https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json
$ dotnet tool install -g dotnet-dump --version 1.0.3-preview5.19228.1
You can invoke the tool using the following command: dotnet-dump
Tool 'dotnet-dump' (version '1.0.3-preview5.19228.1') was successfully installed.

Expand Down Expand Up @@ -109,3 +109,11 @@ To display the help:

$ dotnet tool uninstall -g dotnet-dump
Tool 'dotnet-dump' (version '1.0.3-preview5.19228.1') was successfully uninstalled.

## Release Notes

Preview5

* dotnet-dump does not work on alpine and other MUSL based distros. Issue [#195](https://github.com/dotnet/diagnostics/issues/195).
* dotnet-dump collect requires SYS\_PTRACE docker capabilities (--cap-add=SYS\_PTRACE or --privileged).
* dotnet-dump analyze in Microsoft SDK docker images throws `Unhandled exception: System.DllNotFoundException: Unable to load shared library 'libdl.so' or one of its dependencies` exception. Issue [#201](https://github.com/dotnet/diagnostics/issues/201).
2 changes: 1 addition & 1 deletion documentation/dotnet-trace-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The dotnet-trace tool is a cross-platform CLI global tool that enables the colle
The first step is to install the dotnet-trace CLI global tool. This requires at least version 2.1 of the SDK to be installed.

```cmd
$ dotnet tool install --global dotnet-trace --version 1.0.3-preview5.19228.1 --add-source https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json
$ dotnet tool install --global dotnet-trace --version 1.0.3-preview5.19228.1
You can invoke the tool using the following command: dotnet-trace
Tool 'dotnet-trace' (version '1.0.3-preview5.19228.1') was successfully installed.
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/installing-sos-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Installing SOS on Linux and MacOS

The first step is to install the dotnet-sos CLI global tool. This requires the 2.1 .NET Core SDK to be installed. If you see the error message `Tool 'dotnet-sos' is already installed`, you will need to uninstall the global tool (see below).

$ dotnet tool install -g dotnet-sos --version 1.0.3-preview5.19228.1 --add-source https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json
$ dotnet tool install -g dotnet-sos --version 1.0.3-preview5.19228.1
You can invoke the tool using the following command: dotnet-sos
Tool 'dotnet-sos' (version '1.0.3-preview5.19228.1') was successfully installed.

Expand Down
4 changes: 2 additions & 2 deletions documentation/installing-sos-windows-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ SOS will automatically be loaded from the internal Microsoft extension gallery.

It is recommended that you update to the newer versions of the Windows debugger, but you can still use the latest SOS with older Windows debuggers by using the dotnet-sos CLI global tool to install. It is not as convenient. You may have to ".unload" the SOS that is loaded from the "runtime" directory.

C:\Users\mikem>dotnet tool install -g dotnet-sos --version 1.0.3-preview5.19228.1 --add-source https://dotnetfeed.blob.core.windows.net/dotnet-core/index.json
C:\Users\mikem>dotnet tool install -g dotnet-sos --version 1.0.3-preview5.19228.1
You can invoke the tool using the following command: dotnet-sos
Tool 'dotnet-sos' (version '1.0.3-preview5.19228.1') was successfully installed.

Expand Down Expand Up @@ -90,4 +90,4 @@ SOS will need to be loaded manually with the above ".load" command:
[path: C:\Program Files\Debugging Tools for Windows (x64)\dbghelp.dll]
...
ntsdexts: image 10.0.18317.1001, API 1.0.0,
[path: C:\Program Files\Debugging Tools for Windows (x64)\WINXP\ntsdexts.dll]
[path: C:\Program Files\Debugging Tools for Windows (x64)\WINXP\ntsdexts.dll]

0 comments on commit 4936a8c

Please sign in to comment.