From 3047bd4339e3f3c7d182546682b75066ade50ba9 Mon Sep 17 00:00:00 2001 From: RedMser Date: Wed, 1 May 2024 13:09:11 +0200 Subject: [PATCH] Ensure --doctool is run from root directory when implicit cwd is used --- main/main.cpp | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/main/main.cpp b/main/main.cpp index eee634086e33..7b61eba836ed 100644 --- a/main/main.cpp +++ b/main/main.cpp @@ -3182,6 +3182,7 @@ int Main::start() { #ifdef TOOLS_ENABLED String doc_tool_path; + bool doc_tool_implicit_cwd = false; BitField gen_flags; String _export_preset; bool export_debug = false; @@ -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 @@ -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 } @@ -3308,6 +3311,11 @@ int Main::start() { { Ref 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 @@ -3636,7 +3644,7 @@ int Main::start() { } } - if (doc_tool_path == ".") { + if (doc_tool_implicit_cwd) { doc_tool_path = "./docs"; }