[timings-export] Improve help messages

Also make `clang` happy as concerns the build settings switch/case.
This commit is contained in:
Jeroen van Rijn
2021-11-09 22:52:26 +01:00
parent 6c306f7633
commit 9dc8753a14
+78 -69
View File
@@ -1256,87 +1256,88 @@ bool parse_build_flags(Array<String> args) {
break; break;
} }
case BuildFlag_Debug: case BuildFlag_Debug: {
build_context.ODIN_DEBUG = true; build_context.ODIN_DEBUG = true;
break; break;
}
case BuildFlag_DisableAssert: case BuildFlag_DisableAssert: {
build_context.ODIN_DISABLE_ASSERT = true; build_context.ODIN_DISABLE_ASSERT = true;
break; break;
}
case BuildFlag_NoBoundsCheck: case BuildFlag_NoBoundsCheck: {
build_context.no_bounds_check = true; build_context.no_bounds_check = true;
break; break;
}
case BuildFlag_NoDynamicLiterals: case BuildFlag_NoDynamicLiterals: {
build_context.no_dynamic_literals = true; build_context.no_dynamic_literals = true;
break; break;
}
case BuildFlag_NoCRT: case BuildFlag_NoCRT: {
build_context.no_crt = true; build_context.no_crt = true;
break; break;
}
case BuildFlag_NoEntryPoint: case BuildFlag_NoEntryPoint: {
build_context.no_entry_point = true; build_context.no_entry_point = true;
break; break;
}
case BuildFlag_UseLLD: case BuildFlag_UseLLD: {
build_context.use_lld = true; build_context.use_lld = true;
break; break;
}
case BuildFlag_UseSeparateModules: case BuildFlag_UseSeparateModules: {
build_context.use_separate_modules = true; build_context.use_separate_modules = true;
break; break;
}
case BuildFlag_ThreadedChecker: case BuildFlag_ThreadedChecker: {
#if defined(DEFAULT_TO_THREADED_CHECKER) #if defined(DEFAULT_TO_THREADED_CHECKER)
gb_printf_err("-threaded-checker is the default on this platform\n"); gb_printf_err("-threaded-checker is the default on this platform\n");
bad_flags = true; bad_flags = true;
#endif #endif
build_context.threaded_checker = true; build_context.threaded_checker = true;
break; break;
}
case BuildFlag_NoThreadedChecker: case BuildFlag_NoThreadedChecker: {
#if !defined(DEFAULT_TO_THREADED_CHECKER) #if !defined(DEFAULT_TO_THREADED_CHECKER)
gb_printf_err("-no-threaded-checker is the default on this platform\n"); gb_printf_err("-no-threaded-checker is the default on this platform\n");
bad_flags = true; bad_flags = true;
#endif #endif
build_context.threaded_checker = false; build_context.threaded_checker = false;
break; break;
}
case BuildFlag_ShowDebugMessages: case BuildFlag_ShowDebugMessages: {
build_context.show_debug_messages = true; build_context.show_debug_messages = true;
break; break;
}
case BuildFlag_Vet: case BuildFlag_Vet: {
build_context.vet = true; build_context.vet = true;
break; break;
case BuildFlag_VetExtra: }
case BuildFlag_VetExtra: {
build_context.vet = true; build_context.vet = true;
build_context.vet_extra = true; build_context.vet_extra = true;
break; break;
}
case BuildFlag_UseLLVMApi: case BuildFlag_UseLLVMApi: {
gb_printf_err("-llvm-api flag is not required any more\n"); gb_printf_err("-llvm-api flag is not required any more\n");
bad_flags = true; bad_flags = true;
break; break;
}
case BuildFlag_IgnoreUnknownAttributes: case BuildFlag_IgnoreUnknownAttributes: {
build_context.ignore_unknown_attributes = true; build_context.ignore_unknown_attributes = true;
break; break;
}
case BuildFlag_ExtraLinkerFlags: case BuildFlag_ExtraLinkerFlags: {
GB_ASSERT(value.kind == ExactValue_String); GB_ASSERT(value.kind == ExactValue_String);
build_context.extra_linker_flags = value.value_string; build_context.extra_linker_flags = value.value_string;
break; break;
}
case BuildFlag_Microarch: case BuildFlag_Microarch: {
GB_ASSERT(value.kind == ExactValue_String); GB_ASSERT(value.kind == ExactValue_String);
build_context.microarch = value.value_string; build_context.microarch = value.value_string;
string_to_lower(&build_context.microarch); string_to_lower(&build_context.microarch);
break; break;
}
case BuildFlag_TestName: case BuildFlag_TestName: {
GB_ASSERT(value.kind == ExactValue_String); GB_ASSERT(value.kind == ExactValue_String);
{ {
String name = value.value_string; String name = value.value_string;
@@ -1350,35 +1351,35 @@ bool parse_build_flags(Array<String> args) {
// NOTE(bill): Allow for multiple -test-name // NOTE(bill): Allow for multiple -test-name
continue; continue;
} }
}
case BuildFlag_DisallowDo: case BuildFlag_DisallowDo: {
build_context.disallow_do = true; build_context.disallow_do = true;
break; break;
}
case BuildFlag_DefaultToNilAllocator: case BuildFlag_DefaultToNilAllocator: {
build_context.ODIN_DEFAULT_TO_NIL_ALLOCATOR = true; build_context.ODIN_DEFAULT_TO_NIL_ALLOCATOR = true;
break; break;
}
case BuildFlag_InsertSemicolon: case BuildFlag_InsertSemicolon: {
gb_printf_err("-insert-semicolon flag is not required any more\n"); gb_printf_err("-insert-semicolon flag is not required any more\n");
bad_flags = true; bad_flags = true;
break; break;
}
case BuildFlag_StrictStyle: case BuildFlag_StrictStyle: {
if (build_context.strict_style_init_only) { if (build_context.strict_style_init_only) {
gb_printf_err("-strict-style and -strict-style-init-only cannot be used together\n"); gb_printf_err("-strict-style and -strict-style-init-only cannot be used together\n");
} }
build_context.strict_style = true; build_context.strict_style = true;
break; break;
case BuildFlag_StrictStyleInitOnly: }
case BuildFlag_StrictStyleInitOnly: {
if (build_context.strict_style) { if (build_context.strict_style) {
gb_printf_err("-strict-style and -strict-style-init-only cannot be used together\n"); gb_printf_err("-strict-style and -strict-style-init-only cannot be used together\n");
} }
build_context.strict_style_init_only = true; build_context.strict_style_init_only = true;
break; break;
}
case BuildFlag_Compact: {
case BuildFlag_Compact:
if (!build_context.query_data_set_settings.ok) { if (!build_context.query_data_set_settings.ok) {
gb_printf_err("Invalid use of -compact flag, only allowed with 'odin query'\n"); gb_printf_err("Invalid use of -compact flag, only allowed with 'odin query'\n");
bad_flags = true; bad_flags = true;
@@ -1386,8 +1387,8 @@ bool parse_build_flags(Array<String> args) {
build_context.query_data_set_settings.compact = true; build_context.query_data_set_settings.compact = true;
} }
break; break;
}
case BuildFlag_GlobalDefinitions: case BuildFlag_GlobalDefinitions: {
if (!build_context.query_data_set_settings.ok) { if (!build_context.query_data_set_settings.ok) {
gb_printf_err("Invalid use of -global-definitions flag, only allowed with 'odin query'\n"); gb_printf_err("Invalid use of -global-definitions flag, only allowed with 'odin query'\n");
bad_flags = true; bad_flags = true;
@@ -1398,7 +1399,8 @@ bool parse_build_flags(Array<String> args) {
build_context.query_data_set_settings.kind = QueryDataSet_GlobalDefinitions; build_context.query_data_set_settings.kind = QueryDataSet_GlobalDefinitions;
} }
break; break;
case BuildFlag_GoToDefinitions: }
case BuildFlag_GoToDefinitions: {
if (!build_context.query_data_set_settings.ok) { if (!build_context.query_data_set_settings.ok) {
gb_printf_err("Invalid use of -go-to-definitions flag, only allowed with 'odin query'\n"); gb_printf_err("Invalid use of -go-to-definitions flag, only allowed with 'odin query'\n");
bad_flags = true; bad_flags = true;
@@ -1409,17 +1411,20 @@ bool parse_build_flags(Array<String> args) {
build_context.query_data_set_settings.kind = QueryDataSet_GoToDefinitions; build_context.query_data_set_settings.kind = QueryDataSet_GoToDefinitions;
} }
break; break;
}
case BuildFlag_Short: case BuildFlag_Short: {
build_context.cmd_doc_flags |= CmdDocFlag_Short; build_context.cmd_doc_flags |= CmdDocFlag_Short;
break; break;
case BuildFlag_AllPackages: }
case BuildFlag_AllPackages: {
build_context.cmd_doc_flags |= CmdDocFlag_AllPackages; build_context.cmd_doc_flags |= CmdDocFlag_AllPackages;
break; break;
case BuildFlag_DocFormat: }
case BuildFlag_DocFormat: {
build_context.cmd_doc_flags |= CmdDocFlag_DocFormat; build_context.cmd_doc_flags |= CmdDocFlag_DocFormat;
break; break;
case BuildFlag_IgnoreWarnings: }
case BuildFlag_IgnoreWarnings: {
if (build_context.warnings_as_errors) { if (build_context.warnings_as_errors) {
gb_printf_err("-ignore-warnings cannot be used with -warnings-as-errors\n"); gb_printf_err("-ignore-warnings cannot be used with -warnings-as-errors\n");
bad_flags = true; bad_flags = true;
@@ -1427,7 +1432,8 @@ bool parse_build_flags(Array<String> args) {
build_context.ignore_warnings = true; build_context.ignore_warnings = true;
} }
break; break;
case BuildFlag_WarningsAsErrors: }
case BuildFlag_WarningsAsErrors: {
if (build_context.ignore_warnings) { if (build_context.ignore_warnings) {
gb_printf_err("-warnings-as-errors cannot be used with -ignore-warnings\n"); gb_printf_err("-warnings-as-errors cannot be used with -ignore-warnings\n");
bad_flags = true; bad_flags = true;
@@ -1435,21 +1441,21 @@ bool parse_build_flags(Array<String> args) {
build_context.warnings_as_errors = true; build_context.warnings_as_errors = true;
} }
break; break;
}
case BuildFlag_VerboseErrors: case BuildFlag_VerboseErrors: {
build_context.show_error_line = true; build_context.show_error_line = true;
break; break;
}
case BuildFlag_InternalIgnoreLazy: case BuildFlag_InternalIgnoreLazy: {
build_context.ignore_lazy = true; build_context.ignore_lazy = true;
break; break;
}
#if defined(GB_SYSTEM_WINDOWS) #if defined(GB_SYSTEM_WINDOWS)
case BuildFlag_IgnoreVsSearch: case BuildFlag_IgnoreVsSearch: {
GB_ASSERT(value.kind == ExactValue_Invalid); GB_ASSERT(value.kind == ExactValue_Invalid);
build_context.ignore_microsoft_magic = true; build_context.ignore_microsoft_magic = true;
break; break;
}
case BuildFlag_ResourceFile: { case BuildFlag_ResourceFile: {
GB_ASSERT(value.kind == ExactValue_String); GB_ASSERT(value.kind == ExactValue_String);
String path = value.value_string; String path = value.value_string;
@@ -1537,15 +1543,15 @@ bool parse_build_flags(Array<String> args) {
} }
if ((!(build_context.export_timings_format == TimingsExportUnspecified)) && (build_context.export_timings_file.len == 0)) { if ((!(build_context.export_timings_format == TimingsExportUnspecified)) && (build_context.export_timings_file.len == 0)) {
gb_printf_err("`-export-timings:format` requires `-export-timings-file:filename` to be specified as well\n"); gb_printf_err("`-export-timings:<format>` requires `-export-timings-file:<filename>` to be specified as well\n");
bad_flags = true; bad_flags = true;
} else if ((build_context.export_timings_format == TimingsExportUnspecified) && (build_context.export_timings_file.len > 0)) { } else if ((build_context.export_timings_format == TimingsExportUnspecified) && (build_context.export_timings_file.len > 0)) {
gb_printf_err("`-export-timings-file:filename` requires `-export-timings:format` to be specified as well\n"); gb_printf_err("`-export-timings-file:<filename>` requires `-export-timings:<format>` to be specified as well\n");
bad_flags = true; bad_flags = true;
} }
if (build_context.export_timings_format && !(build_context.show_timings || build_context.show_more_timings)) { if (build_context.export_timings_format && !(build_context.show_timings || build_context.show_more_timings)) {
gb_printf_err("`-export-timings:format` requires `-show-timings` or `-show-more-timings` to be present\n"); gb_printf_err("`-export-timings:<format>` requires `-show-timings` or `-show-more-timings` to be present\n");
bad_flags = true; bad_flags = true;
} }
@@ -1898,13 +1904,16 @@ void print_show_help(String const arg0, String const &command) {
print_usage_line(2, "Shows an advanced overview of the timings of different stages within the compiler in milliseconds"); print_usage_line(2, "Shows an advanced overview of the timings of different stages within the compiler in milliseconds");
print_usage_line(0, ""); print_usage_line(0, "");
print_usage_line(1, "-export-timings"); print_usage_line(1, "-export-timings:<format>");
print_usage_line(2, "Export timings to one of a few formats. Requires `-show-timings` or `-show-more-timings`"); print_usage_line(2, "Export timings to one of a few formats. Requires `-show-timings` or `-show-more-timings`");
print_usage_line(2, "Accepted values: json, csv"); print_usage_line(2, "Available options:");
print_usage_line(3, "-export-timings:json Export compile time stats to JSON");
print_usage_line(3, "-export-timings:csv Export compile time stats to CSV");
print_usage_line(0, ""); print_usage_line(0, "");
print_usage_line(1, "-export-timings-file:filename"); print_usage_line(1, "-export-timings-file:<filename>");
print_usage_line(2, "Specify the filename for `-export-timings`."); print_usage_line(2, "Specify the filename for `-export-timings`");
print_usage_line(2, "Example: -export-timings-file:timings.json");
print_usage_line(0, ""); print_usage_line(0, "");
print_usage_line(1, "-thread-count:<integer>"); print_usage_line(1, "-thread-count:<integer>");