From 2dcf41e46644ebf3a7d2ffd1cf68de592bb9b53e Mon Sep 17 00:00:00 2001 From: Tim Pilius Date: Fri, 2 Feb 2024 20:28:12 -0500 Subject: [PATCH] Renaming presets to SmallChunks and LargeChunks, as this makes more sense than having the game name directly. --- SteamPrefill/CliCommands/Benchmark/BenchmarkModels.cs | 4 ++-- SteamPrefill/CliCommands/Benchmark/BenchmarkSetupCommand.cs | 2 +- SteamPrefill/CliCommands/Converters.cs | 4 ++-- SteamPrefill/Properties/launchSettings.json | 2 +- docs/mkdocs/detailed-command-usage/Benchmark.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/SteamPrefill/CliCommands/Benchmark/BenchmarkModels.cs b/SteamPrefill/CliCommands/Benchmark/BenchmarkModels.cs index 401abce2..4ce94848 100644 --- a/SteamPrefill/CliCommands/Benchmark/BenchmarkModels.cs +++ b/SteamPrefill/CliCommands/Benchmark/BenchmarkModels.cs @@ -234,7 +234,7 @@ public override string ToString() [Intellenum(typeof(string))] public sealed partial class PresetWorkload { - public static readonly PresetWorkload Destiny2 = new PresetWorkload("1085660"); - public static readonly PresetWorkload Dota2 = new PresetWorkload("570"); + public static readonly PresetWorkload BigChunks = new PresetWorkload("1085660"); + public static readonly PresetWorkload SmallChunks = new PresetWorkload("570"); } } \ No newline at end of file diff --git a/SteamPrefill/CliCommands/Benchmark/BenchmarkSetupCommand.cs b/SteamPrefill/CliCommands/Benchmark/BenchmarkSetupCommand.cs index 0abf18ce..813e4f3e 100644 --- a/SteamPrefill/CliCommands/Benchmark/BenchmarkSetupCommand.cs +++ b/SteamPrefill/CliCommands/Benchmark/BenchmarkSetupCommand.cs @@ -21,7 +21,7 @@ public class BenchmarkSetupCommand : ICommand public bool? NoAnsiEscapeSequences { get; init; } [CommandOption("preset", - Description = "Sets up a benchmark with one or more preset workloads, with differing performance characteristics. Can be Destiny2/Dota2", + Description = "Sets up a benchmark with one or more preset workloads, with differing performance characteristics. Can be SmallChunks/BigChunks", Converter = typeof(PresetWorkloadConverter), Validators = new[] { typeof(PresetWorkloadValidator) })] public IReadOnlyList Presets { get; init; } = new List { }; diff --git a/SteamPrefill/CliCommands/Converters.cs b/SteamPrefill/CliCommands/Converters.cs index 6a61490d..7ef51de8 100644 --- a/SteamPrefill/CliCommands/Converters.cs +++ b/SteamPrefill/CliCommands/Converters.cs @@ -66,7 +66,7 @@ public override BindingValidationError Validate(PresetWorkload[] value) if (value.Length == 0) { AnsiConsole.MarkupLine(Red($"A preset must be specified when using {LightYellow("--preset")}")); - AnsiConsole.Markup(Red($"Valid presets include : {LightYellow("Destiny2/Dota2")}")); + AnsiConsole.Markup(Red($"Valid presets include : {LightYellow("SmallChunks/BigChunks")}")); throw new CommandException(".", 1, true); } return Ok(); @@ -82,7 +82,7 @@ public override PresetWorkload Convert(string rawValue) if (!PresetWorkload.TryFromName(rawValue, out var _)) { AnsiConsole.MarkupLine(Red($"{White(rawValue)} is not a valid preset")); - AnsiConsole.Markup(Red($"Valid presets include : {LightYellow("Destiny2/Dota2")}")); + AnsiConsole.Markup(Red($"Valid presets include : {LightYellow("SmallChunks/BigChunks")}")); throw new CommandException(".", 1, true); } return PresetWorkload.FromName(rawValue); diff --git a/SteamPrefill/Properties/launchSettings.json b/SteamPrefill/Properties/launchSettings.json index 00722e87..2b955186 100644 --- a/SteamPrefill/Properties/launchSettings.json +++ b/SteamPrefill/Properties/launchSettings.json @@ -22,7 +22,7 @@ }, "Benchmark - Setup - Preset": { "commandName": "Project", - "commandLineArgs": "benchmark setup --preset Destiny2" + "commandLineArgs": "benchmark setup -h" }, "Benchmark - Setup - All": { "commandName": "Project", diff --git a/docs/mkdocs/detailed-command-usage/Benchmark.md b/docs/mkdocs/detailed-command-usage/Benchmark.md index 0a38e014..157c282b 100644 --- a/docs/mkdocs/detailed-command-usage/Benchmark.md +++ b/docs/mkdocs/detailed-command-usage/Benchmark.md @@ -31,8 +31,8 @@ Creates a benchmark "workload" comprised of multiple apps, that will then be ben | --all | | Benchmark workload will be created using all currently owned apps. | | --appid | | The id of one or more apps to include in benchmark workload file. Useful for testing a specific app, without having to modify previously selected apps. AppIds can be found using [SteamDB](https://steamdb.info/) | | --no-ansi | | Application output will be in plain text, rather than using the visually appealing colors and progress bars. Should only be used if terminal does not support Ansi Escape sequences, or when redirecting output to a file. | -| --preset | Dota2, Destiny2 | Can be used to quickly setup a benchmark with a predefined workload of differing characteristics. Destiny2 represents a best case scenario where chunk sizes are close to 1Mib, whereas Dota2 is a worst case scenario of small files. | - +| --preset | SmallChunks, LargeChunks | Can be used to quickly setup a benchmark with a predefined workload of differing characteristics. LargeChunks represents a best case scenario where chunk sizes are close to 1Mib, whereas SmallChunks is a worst case scenario of small files. | + ----- ## run