Update help to reflect latest changes with compressed json files.

Siemens-Healthineers · Jun 18, 2024 · c285ae7 · c285ae7
1 parent 632af30
commit c285ae7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/ETWAnalyzer/Commands/ExtractCommand.cs b/ETWAnalyzer/Commands/ExtractCommand.cs
@@ -34,8 +34,10 @@ namespace ETWAnalyzer.Commands
     /// </summary>
     class ExtractCommand : ArgParser
     {
+        internal const string AllExtractCommands = "All, Default or CPU Disk Dns Exception File Frequency Memory Module ObjectRef PMC Power Stacktag TCP ThreadPool";
+
         internal static readonly string HelpString =
-         "ETWAnalyzer [-extract [All, Default or CPU Disk Dns Exception File Frequency Memory Module ObjectRef PMC Power Stacktag TCP ThreadPool] -filedir/-fd inEtlOrZip [-DryRun] [-symServer NtSymbolPath/MS/Google/syngo] [-keepTemp] [-NoOverwrite] [-pThreads dd] [-nThreads dd]" + Environment.NewLine +
+        $"ETWAnalyzer [-extract [{AllExtractCommands}] -filedir/-fd inEtlOrZip [-DryRun] [-symServer NtSymbolPath/MS/Google/syngo] [-keepTemp] [-NoOverwrite] [-pThreads dd] [-nThreads dd]" + Environment.NewLine +
          "            [-NoReady] [-allCPU] [-Concurrency dd] [-NoIndent] [-NoCompress] [-LastNDays dd] [-TestsPerRun dd -SkipNTests dd] [-TestRunIndex dd -TestRunCount dd] [-NoTestRunGrouping]  " + Environment.NewLine + 
          "Retrieve data from ETL files and store extracted data in a serialized format in Json in the output directory \\Extract folder." + Environment.NewLine +
          "The data can the be analyzed by other tools or ETWAnalyzer itself which can also analyze the data for specific patterns or issues." + Environment.NewLine +

diff --git a/ETWAnalyzer/Commands/HelpCommand.cs b/ETWAnalyzer/Commands/HelpCommand.cs
@@ -17,23 +17,23 @@ class HelpCommand : ICommand
         private static readonly string HelpString =
            $"ETWAnalyzer {FileVersionInfo.GetVersionInfo(Process.GetCurrentProcess().MainModule.FileName).FileVersion}" + Environment.NewLine +
             " ETWAnalyzer [green]-help[/green] [Extract, Dump, Console, Convert or LoadSymbol]  Get further information about the specific sub command" + Environment.NewLine +
-            " ETWAnalyzer [green]-Extract[/green] [All or Cpu Disk File Module Memory Exception Stacktag ThreadPool Pmc Dns Power Frequency Tcp] -filedir inEtlOrZip [-outDir xxxxx] [-symServer [MS, syngo or NtSymbolPath] [-keepTemp] [-symFolder bbbb]" + Environment.NewLine +
+            " ETWAnalyzer [green]-Console[/green]" + Environment.NewLine +
+            "        Interactive mode. Useful if working with bigger data sets without the need to reload data on every query. Enter .help to get more information." + Environment.NewLine +
+            " ETWAnalyzer [green]-Convert[/green] -filedir xx.etl -pid dd [-perthread]" + Environment.NewLine +
+            "        Convert from an ETL File a process to a speedscope json file." + Environment.NewLine +
+           $" ETWAnalyzer [green]-Dump[/green] {DumpCommand.AllDumpCommands}" + Environment.NewLine +
+            "        Dump previously extracted data from Json files. Some commands additionally support ETL files (e.g. -dump Process)" + Environment.NewLine +
+           $" ETWAnalyzer [green]-Extract[/green] [{ExtractCommand.AllExtractCommands}] -filedir inEtlOrZip [-outDir xxxxx] [-symServer [MS, syngo or NtSymbolPath] [-keepTemp] [-symFolder bbbb]" + Environment.NewLine +
             "        Extract data from etl file/s and write summary data into json files." + Environment.NewLine +
             " ETWAnalyzer [green]-LoadSymbol[/green] -filedir xxx.json -symserver ..." + Environment.NewLine +
             "        Resolve method names from an extracted Json file." + Environment.NewLine +
-            " ETWAnalyzer [green]-Dump[/green] [Stats,Process,CPU,Stacktag,Memory,Disk,File,ThreadPool,Exception,Mark,TestRun,Version,PMC,LBR,Dns,Power,TCP]" + Environment.NewLine +
-            "        Dump previously extracted data from Json files. Some commands additionally support ETL files (e.g. -dump Process)" + Environment.NewLine +
-            " ETWAnalyzer [green]-Convert[/green] -filedir xx.etl -pid dd [-perthread]" + Environment.NewLine +
-            "        Convert from an ETL File a process to a speedscope json file." + Environment.NewLine +
-            " ETWAnalyzer [green]-Console[/green]" + Environment.NewLine +
-            "        Interactive mode. Useful if working with bigger data sets without the need to reload data on every query. Enter .help to get more information." + Environment.NewLine +
             "[yellow]Examples:[/yellow] " + Environment.NewLine +
             "[green]Get more help on specific option[/green]" + Environment.NewLine +
             "    ETWAnalyzer -help [Extract, Dump, Convert or Loadsymbol]" + Environment.NewLine +
-            "[green]Extract data from ETL and store it in Json file in extract folder beneath ETL[/green]" + Environment.NewLine +
+            "[green]Extract data from ETL and store it in .json7z file in Extract folder beneath ETL.[/green]" + Environment.NewLine +
             "   ETWAnalyzer -extract All -filedir xxx.etl -symserver  NtSymbolPath" + Environment.NewLine +
-            "[green]Dump Process start/stop information to console by reading the Json file which was generated in the previous (extract) step.[/green]" + Environment.NewLine +
-            "   ETWAnalyzer -dump Process -filedir .\\Extract\\xxx.json" 
+            "[green]Dump Process start/stop information to console by reading the compressed json file which was generated in the previous (extract) step.[/green]" + Environment.NewLine +
+            "   ETWAnalyzer -dump Process -filedir .\\Extract\\xxx.json7z" 
             ;
 
         /// <summary>