Skip to content

Don't update script documentation when exporting #107685

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KoBeWi
Copy link
Member

@KoBeWi KoBeWi commented Jun 18, 2025

Makes the editor skip updating script documentation and scene groups when exporting or running headless.

Fixes #107407 (please test)
Probably fixes #105327 (I tested and seems fixed, but the crash is random)

@bruvzg
Copy link
Member

bruvzg commented Jun 19, 2025

Still crashing, but will a bit lower probability (and usually on reexports).

CowData<EditorFileSystemDirectory::FileInfo*>::size() const (/Volumes/Backup/Projects/godot/core/templates/cowdata.h:165)
Vector<EditorFileSystemDirectory::FileInfo*>::size() const (/Volumes/Backup/Projects/godot/core/templates/vector.h:91)
EditorFileSystemDirectory::get_file_count() const (/Volumes/Backup/Projects/godot/editor/editor_file_system.cpp:91)
EditorHelp::_reload_scripts_documentation(EditorFileSystemDirectory*) (/Volumes/Backup/Projects/godot/editor/editor_help.cpp:3200)
EditorHelp::_reload_scripts_documentation(EditorFileSystemDirectory*) (/Volumes/Backup/Projects/godot/editor/editor_help.cpp:3197)
EditorHelp::_regen_script_doc_thread(void*) (/Volumes/Backup/Projects/godot/editor/editor_help.cpp:3187)
Thread::thread_callback(void*) (/Volumes/Backup/Projects/godot/drivers/apple/thread_apple.cpp:55)
_pthread_start (@_pthread_start:37)

@KoBeWi KoBeWi force-pushed the useless_documentation branch from b0c4abe to 4b39394 Compare June 19, 2025 11:32
@KoBeWi
Copy link
Member Author

KoBeWi commented Jun 19, 2025

Check again.

@akien-mga
Copy link
Member

Fixes #107407 (please test)

I confirm that both this PR and #107699 seem to solve that crash.
Which solution should we go for?

@KoBeWi
Copy link
Member Author

KoBeWi commented Jun 26, 2025

From what I see, my PR takes effect earlier, so waiting for thread is not necessary here (I think?). I also block scene group updates.

The other PR is somewhat cleaner, but seems to be only preventing the doc methods from doing something, instead of preventing them from being called at all.

My changes are probably better, but it would be nice if @bruvzg could confirm that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

_regen_script_doc_thread crashes because it might be still running on exit GDScript cleanup crash after exporting project
3 participants