godotengine / godotengine/godot-docs
Fix compilation database command for CLion page.
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 25
Description
**Your Godot version:** 4.x, I`m not sure if this applies to 3.x
**Issue description:** The Clion documentation page's **Importing the project** section instructs to generate a compilation database with `scons compiledb=yes`, and then the next section compiles the engine normally with `scons`, however, running that first command also compiles the engine. I think this should be consistent, either by correcting the command to `scons compiledb=yes compile_commands.json` (doesn't compile the engine) in the first section, or just linking the compilation database instructions to the **Configuring an IDE** section, which describes both commands.
**URL to the documentation page (if already existing):**
- **Importing the project (CLion`s page)**: https://docs.godotengine.org/en/stable/contributing/development/configuring_an_ide/clion.html#importing-the-project
- **Configuring an IDE**: https://docs.godotengine.org/en/stable/contributing/development/configuring_an_ide/index.html#configuring-an-ide
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.