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.

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

Missing scons command in GDExtension C++ example docs, also potentially outdated command when git cloning #9365

Open
PabloIsCoding opened this issue May 12, 2024 · 3 comments
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug

Comments

@PabloIsCoding
Copy link

Your Godot version: 4.2

Issue description: Missing command (and possibly an outdated one also) in docs

URL to the documentation page: https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_cpp_example.html

The docs say:

"To generate and compile the bindings, use this command (replacing with windows, linux or macos depending on your OS):

The build process automatically detects the number of CPU threads [...]"

So there is a missing command in between those lines. I believe the missing command is scons platform=<platform> but this is my first time doing this so idk. There is also a call to scons later on, so maybe this one is redundant.

Also, I noticed that when cloning the repo it forces the 4.1 branch, but I think it should clone the 4.2 (?)

Hope this helps

@PabloIsCoding PabloIsCoding changed the title Missing scons command in docs, also potentially outdated command when git cloning Missing scons command in GDExtension C++ example docs, also potentially outdated command when git cloning May 12, 2024
@skyace65 skyace65 added the area:manual Issues and PRs related to the Manual/Tutorials section of the documentation label May 12, 2024
@PabloIsCoding
Copy link
Author

Following the guide in godot 4.2 I couldn't make the example work, but it worked when switching to 4.1, so maybe it's good that the clone commands gets the 4.1. Still, there should be a warning specifying that this will only work in 4.1.

@dsnopek
Copy link
Contributor

dsnopek commented May 13, 2024

@PabloIsCoding Can you provide some details about what went wrong? Was there an error? Making an issue on the godot-cpp repo would be much appreciated

@PabloIsCoding
Copy link
Author

Well I tried to reproduce it today from scratch and it works. My guess is that I was either compiling the godot-cpp master branch or the 4.1 branch instead of 4.2.

Question: isn't 4.2 the latest stable version? The docs for the cpp example still seem to point to 4.1

The 4.2 docs (https://docs.godotengine.org/en/4.2/tutorials/scripting/gdextension/gdextension_cpp_example.html) say:

mkdir gdextension_cpp_example
cd gdextension_cpp_example
git clone -b 4.2 https://github.com/godotengine/godot-cpp

While stable (https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_cpp_example.html) says

mkdir gdextension_cpp_example
cd gdextension_cpp_example
git clone -b 4.1 https://github.com/godotengine/godot-cpp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug
Projects
None yet
Development

No branches or pull requests

3 participants