Update dotnet-tools.md
authorMohammad Mustakim Ali <mustakimali@users.noreply.github.com>
Sun, 29 Mar 2020 16:16:32 +0000 (17:16 +0100)
committerGitHub <noreply@github.com>
Sun, 29 Mar 2020 16:16:32 +0000 (17:16 +0100)
documentation/design-docs/dotnet-tools.md

index 506644b045792b3091e17fe6bf3224c3cb46c17d..e3d228d1ea9352ccb1f88ffaff0255464bd7762d 100644 (file)
@@ -666,34 +666,36 @@ Examples:
 
 REPORT
 
-    dotnet-gcdump report -f|--file <input_dump_path>
+    dotnet-gcdump report <gcdump_filename>
     
     Generate report into stdout from a previously generated gcdump or from a running process.
     
     Usage:
-      dotnet-gcdump report [options]
-    
+      dotnet-gcdump report [options] [<gcdump_filename>]
+
+    Arguments:
+      <gcdump_filename>  The file to read gcdump from.
+  
     Options:
-      -f, --file        The file to read gcdump from.
-      -p, --process-id  The process id to collect the trace.
-      -t, --report-type The type of report to generate. Available options: heapstat (default)
+      -p, --process-id   The process id to collect the trace.
+      -t, --report-type  The type of report to generate. Available options: heapstat (default)
 
 Examples:
 
-    $ dotnet gcdump report -f 20200207_094403_19847.gcdump | head -9
+    $ dotnet gcdump report 20200207_094403_19847.gcdump | head -9
       5,080,860  GC Heap bytes
          66,289  GC Heap objects
 
     Object Bytes  Type
-        131,096  System.Byte[] (Bytes > 100K)  [System.Private.CoreLib.dll]
-         57,756  System.String (Bytes > 10K)  [System.Private.CoreLib.dll]
-         31,128  System.Int32[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         28,605  System.Byte[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         22,432  System.Object[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         12,476  System.Char[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-          8,216  System.Char[] (Bytes > 1K)  [System.Private.CoreLib.dll]
-          8,216  System.Byte[] (Bytes > 1K)  [System.Private.CoreLib.dll]
-          8,216  System.UInt32[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+         131,096  System.Byte[] (Bytes > 100K)  [System.Private.CoreLib.dll]
+          57,756  System.String (Bytes > 10K)  [System.Private.CoreLib.dll]
+          31,128  System.Int32[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          28,605  System.Byte[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          22,432  System.Object[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          12,476  System.Char[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+           8,216  System.Char[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+           8,216  System.Byte[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+           8,216  System.UInt32[] (Bytes > 1K)  [System.Private.CoreLib.dll]
 
 
     $ dotnet gcdump report -p 1752 | head -9
@@ -701,15 +703,15 @@ Examples:
          66,289  GC Heap objects
 
     Object Bytes  Type
-        131,096  System.Byte[] (Bytes > 100K)  [System.Private.CoreLib.dll]
-         57,756  System.String (Bytes > 10K)  [System.Private.CoreLib.dll]
-         31,128  System.Int32[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         28,605  System.Byte[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         22,432  System.Object[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-         12,476  System.Char[] (Bytes > 10K)  [System.Private.CoreLib.dll]
-          8,216  System.Char[] (Bytes > 1K)  [System.Private.CoreLib.dll]
-          8,216  System.Byte[] (Bytes > 1K)  [System.Private.CoreLib.dll]
-          8,216  System.UInt32[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+         131,096  System.Byte[] (Bytes > 100K)  [System.Private.CoreLib.dll]
+          57,756  System.String (Bytes > 10K)  [System.Private.CoreLib.dll]
+          31,128  System.Int32[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          28,605  System.Byte[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          22,432  System.Object[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+          12,476  System.Char[] (Bytes > 10K)  [System.Private.CoreLib.dll]
+           8,216  System.Char[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+           8,216  System.Byte[] (Bytes > 1K)  [System.Private.CoreLib.dll]
+           8,216  System.UInt32[] (Bytes > 1K)  [System.Private.CoreLib.dll]
 
 ## Future suggestions