Preview5 doc update. (#225)
authorMike McLaughlin <mikem@microsoft.com>
Tue, 30 Apr 2019 02:17:42 +0000 (19:17 -0700)
committerGitHub <noreply@github.com>
Tue, 30 Apr 2019 02:17:42 +0000 (19:17 -0700)
Add Release notes for dotnet-dump.

Remove --add-source in installation instructions.

documentation/dotnet-dump-instructions.md
documentation/dotnet-trace-instructions.md
documentation/installing-sos-instructions.md
documentation/installing-sos-windows-instructions.md

index 935deceb50609eae85098e3d0e5311ec6a81f20c..9d92737af35c2b305dd9d471db5cd96a04c12185 100644 (file)
@@ -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.
 
@@ -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).
index baa61747c24e64128e1a6b4df671562e8c90b329..15bb077a86c73226711dc7bcc137b5b80de3cc78 100644 (file)
@@ -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.
 ```
index 5f42a0a50bb25292cb2b45681fb0807831ff567e..97a8590fff5fcb4f5245b81b7f83469d3023e27c 100644 (file)
@@ -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.
 
index 63b9d5b364024f34d8eb9bf3e77c26f8968da578..6cd7b1b8bb88733641ba1d0dafa58bc333ba1357 100644 (file)
@@ -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.
 
@@ -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]
\ No newline at end of file
+            [path: C:\Program Files\Debugging Tools for Windows (x64)\WINXP\ntsdexts.dll]