Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ensure --doctool is run from root directory #91407

Merged
merged 1 commit into from
May 1, 2024
Merged

Ensure --doctool is run from root directory #91407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion main/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3182,6 +3182,7 @@ int Main::start() {

#ifdef TOOLS_ENABLED
String doc_tool_path;
bool doc_tool_implicit_cwd = false;
BitField<DocTools::GenerateFlags> gen_flags;
String _export_preset;
bool export_debug = false;
Expand Down Expand Up @@ -3252,6 +3253,7 @@ int Main::start() {
if (doc_tool_path.begins_with("-")) {
// Assuming other command line arg, so default to cwd.
doc_tool_path = ".";
doc_tool_implicit_cwd = true;
parsed_pair = false;
}
#ifdef MODULE_GDSCRIPT_ENABLED
Expand Down Expand Up @@ -3282,6 +3284,7 @@ int Main::start() {
// Handle case where no path is given to --doctool.
else if (args[i] == "--doctool") {
doc_tool_path = ".";
doc_tool_implicit_cwd = true;
}
#endif
}
Expand All @@ -3308,6 +3311,11 @@ int Main::start() {
{
Ref<DirAccess> da = DirAccess::open(doc_tool_path);
ERR_FAIL_COND_V_MSG(da.is_null(), EXIT_FAILURE, "Argument supplied to --doctool must be a valid directory path.");
// Ensure that doctool is running in the root dir, but only if
// user did not manually specify a path as argument.
if (doc_tool_implicit_cwd) {
ERR_FAIL_COND_V_MSG(!da->dir_exists("doc"), EXIT_FAILURE, "--doctool must be run from the Godot repository's root folder, or specify a path that points there.");
}
}

#ifndef MODULE_MONO_ENABLED
Expand Down Expand Up @@ -3636,7 +3644,7 @@ int Main::start() {
}
}

if (doc_tool_path == ".") {
if (doc_tool_implicit_cwd) {
doc_tool_path = "./docs";
}

Expand Down
Loading