Skip to content

Commit

Permalink
Enable -out:<filename> for doc subcommand
Browse files Browse the repository at this point in the history
The logic for writing the .odin-doc file to the value assigned
to out_filepath, this just enables it on the CLI frontend.
  • Loading branch information
InKryption committed Sep 11, 2024
1 parent 244a4ac commit 6eedf7c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ gb_internal bool parse_build_flags(Array<String> args) {
auto build_flags = array_make<BuildFlag>(heap_allocator(), 0, BuildFlag_COUNT);
add_flag(&build_flags, BuildFlag_Help, str_lit("help"), BuildFlagParam_None, Command_all);
add_flag(&build_flags, BuildFlag_SingleFile, str_lit("file"), BuildFlagParam_None, Command__does_build | Command__does_check);
add_flag(&build_flags, BuildFlag_OutFile, str_lit("out"), BuildFlagParam_String, Command__does_build | Command_test);
add_flag(&build_flags, BuildFlag_OutFile, str_lit("out"), BuildFlagParam_String, Command__does_build | Command_test | Command_doc);
add_flag(&build_flags, BuildFlag_OptimizationMode, str_lit("o"), BuildFlagParam_String, Command__does_build);
add_flag(&build_flags, BuildFlag_ShowTimings, str_lit("show-timings"), BuildFlagParam_None, Command__does_check);
add_flag(&build_flags, BuildFlag_ShowMoreTimings, str_lit("show-more-timings"), BuildFlagParam_None, Command__does_check);
Expand Down Expand Up @@ -2164,6 +2164,11 @@ gb_internal void print_show_help(String const arg0, String const &command) {
print_usage_line(1, "-doc-format");
print_usage_line(2, "Generates documentation as the .odin-doc format (useful for external tooling).");
print_usage_line(0, "");

print_usage_line(1, "-out:<filepath>");
print_usage_line(2, "Sets the file name of the outputted .odin-doc file.");
print_usage_line(2, "Example: -out:foo");
print_usage_line(0, "");
}

if (run_or_build) {
Expand Down

0 comments on commit 6eedf7c

Please sign in to comment.