godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for GDExtensions validation.

Browse Source
This commit is contained in:
Pāvels Nadtočajevs
2025-12-03 15:15:10 +02:00
parent 0fce3e79c7
commit 67f9442b9c
1 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
engine_details/development/handling_compatibility_breakages.rst
View File

@@ -114,12 +114,11 @@ Next, this should be included in the ``.cpp`` file we're adding compatibility me
#include "core/variant/typed_array.h"
And finally, the changes reported by the API validation step should be added to the relevant validation file. Because this was
done during the development of 4.3, this would be ``misc/extension_api_validation/4.2-stable.expected`` (including changes not shown in
this example):
And finally, the changes reported by the API validation step should be added to a validation file. Because this was
done during the development of 4.3, the validation file would be in the ``misc/extension_api_validation/4.2-stable/`` folder:
.. code-block:: text
:caption: misc/extension_api_validation/4.2-stable.expected
:caption: misc/extension_api_validation/4.2-stable/GH-88047.txt
GH-88047
--------
@@ -133,10 +132,8 @@ this example):
Added optional "allow_partial_path" argument to get_id_path and get_point_path methods in AStar classes.
Compatibility methods registered.
The instructions for how to add to that file are at the top of the file itself.
If you get a "Hash changed" error for a method, it means that the compatibility binding is missing or incorrect.
Such lines shouldn't be added to the ``.expected`` file, but fixed by binding the proper compatibility method.
Such lines shouldn't be added to the validation file, but fixed by binding the proper compatibility method.
And that's it! You might run into a bit more complicated cases, like rearranging arguments,
changing return types, etc., but this covers the basic on how to use this system.