Skip to content

Commit 2075def

Browse files
Abstract the minor verison number where possible
To ease the maintenance burden in the future, we are abstracting the minor version number to avoid the number of doc updates required.
1 parent 42cb5ef commit 2075def

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

tutorials/scripting/gdextension/gdextension_cpp_example.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,17 @@ of Godot. GDExtensions will not work in older versions of Godot (only Godot 4 an
3535
.. note::
3636
To use `GDExtension <https://godotengine.org/article/introducing-gd-extensions>`__
3737
you need to use the godot-cpp branch that matches the version of Godot that you are
38-
targeting. For example, if you're targeting Godot 4.2, use the ``4.2`` branch,
39-
which is what is shown through out this tutorial.
38+
targeting. For example, if you're targeting Godot 4.1, use the ``4.1`` branch. Throughout
39+
this tutorial we use ``4.x`,` which will need to be replaced with the version of Godot you
40+
are targeting.
4041
4142
The ``master`` branch is the development branch which is updated regularly
4243
to work with Godot's ``master`` branch.
4344

4445
.. warning::
4546
Our long-term goal is that GDExtensions targeting an earlier version of Godot will work
46-
in later minor versions, but not vice-versa. For example, a GDExtension targeting Godot 4.2
47-
should work just fine in Godot 4.3, but one targeting Godot 4.3 won't work in Godot 4.2.
47+
in later minor versions, but not vice-versa. For example, a GDExtension targeting Godot 4.1
48+
should work just fine in Godot 4.2, but one targeting Godot 4.2 won't work in Godot 4.1.
4849

4950
However, GDExtension is currently *experimental*, which means that we may break compatibility
5051
in order to fix major bugs or include critical features. For example, GDExtensions created
@@ -59,7 +60,7 @@ a Git submodule:
5960
mkdir gdextension_cpp_example
6061
cd gdextension_cpp_example
6162
git init
62-
git submodule add -b 4.2 https://github.com/godotengine/godot-cpp
63+
git submodule add -b 4.x https://github.com/godotengine/godot-cpp
6364
cd godot-cpp
6465
git submodule update --init
6566
@@ -69,7 +70,7 @@ Alternatively, you can also clone it to the project folder:
6970
7071
mkdir gdextension_cpp_example
7172
cd gdextension_cpp_example
72-
git clone -b 4.2 https://github.com/godotengine/godot-cpp
73+
git clone -b 4.x https://github.com/godotengine/godot-cpp
7374
7475
.. note::
7576

@@ -332,7 +333,7 @@ build files in a subsequent tutorial.
332333

333334
This ``SConstruct`` file was written to be used with the latest ``godot-cpp``
334335
master, you may need to make small changes using it with older versions or
335-
refer to the ``SConstruct`` file in the Godot 4.2 documentation.
336+
refer to the ``SConstruct`` file in the Godot 4.x documentation.
336337

337338
Once you've downloaded the ``SConstruct`` file, place it in your GDExtension folder
338339
structure alongside ``godot-cpp``, ``src`` and ``demo``, then run:

0 commit comments

Comments
 (0)