Commit Graph

240 Commits

Author SHA1 Message Date
Hugo Locurcio
c59fbbc812 Update GitHub issue URL for encapsulation violations in Editor development
The previously linked issue is now closed.
2023-04-15 21:39:17 +02:00
Andrej Petrović
b20fa95ee3 Update link to set of predefined color mappings in creating_icons.rst 2023-04-15 16:39:38 +01:00
Evan Overly
03732737e1 Added mingw to the scoop install instructions 2023-04-12 15:38:30 -05:00
Hugo Locurcio
123fce7e07 Add a page on using GCC/Clang/MSVC sanitizers
This also covers Web-specific Emscripten options to enable its own
sanitizers.
2023-04-08 20:08:24 +02:00
Max Hilbrunner
425e9492dd Merge pull request #7101 from Riteo/serious-video-game
Change PNG image requirement to SVG in custom platform ports page
2023-03-31 19:41:17 +02:00
Hugo Locurcio
f4efa2fd8a Move rationale about Godot using SCons to Frequently asked questions
This also removes an obsolete bit about the command prompt to use
when compiling using Visual Studio (automatic detection has been
implemented for years).
2023-03-31 19:31:28 +02:00
Riteo
a6359685a6 Change PNG image requirement to SVG in custom platform ports page
It got changed to SVG in godotengine/godot@cebefc9.

I'm not sure if PNGs are supported anymore but I guess that it's still
good practice to use SVGs and this isn't supposed to be a full in-depth
tutorial anyways 🤷
2023-03-31 19:00:05 +02:00
Ron B. Yeh
9d2f8420e3 Fix typo on "linker". 2023-03-30 14:39:44 -07:00
Arman Papikyan
ec7a1d41fb Clarifying some common pitfalls for Visual Studio debugging (#7062)
* Clarifying some common pitfalls for Visual Studio debugging

Two minor changes made to this page, to help other people avoid wasting their time:
1. The page says at the end that it should be possible to place a breakpoint and if the steps were followed properly it should just work, however the dev_buil paramter is not mentioned anywhere in the same page and I would not be able to complete the setup without help from @anvilfolk.
2. I spent a couple of minutes trying to understand why the debugger would not attach and instead would exit with code 255 - no errors or hints shown (like path not found, or could not parse, etc). Ended up being a simple mistake of having white spaces in the path. I think its worth mentioning in the docs.
Also updating the screenshot to suggest double quotation marks by default as safer alternative that can handle whitespaces.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-03-30 20:27:40 +02:00
Hugo Locurcio
b7e5b77850 Improve Introduction to the buildsystem documentation
- Simplify history section on SCons.
- Add a section on `production` and `dev_mode` aliases.
- Add a section on `debug_symbols` and `separate_debug_symbols`.
- Add a section on `optimize`.
2023-03-29 04:32:01 +02:00
Unai Martinez-Corral
08f2c7ce44 [contributing/development/compiling/compiling_for_linuxbsd] update style; use directives (#7059)
* [contributing/development/compiling/compiling_for_linuxbsd] use tabs to show distro-specific one-liners
2023-03-28 07:50:21 +02:00
Max Hilbrunner
b53e989669 Merge pull request #7012 from jwmcgettigan/onready-patch
Updated instances of onready to @onready.
2023-03-23 04:39:30 +01:00
Max Hilbrunner
8d1af60ddb Merge pull request #7036 from ajreckof/update_configuring_xcode
update the page explaining Xcode configuration for engine development
2023-03-23 02:56:28 +01:00
Max Hilbrunner
8d1cfa6c37 Merge pull request #6345 from Calinou/add-custom-platform-ports
Add a page on creating custom platform ports
2023-03-23 02:38:02 +01:00
ajreckof
cc91994efd update the page explaining Xcode configuration for engine development 2023-03-22 21:26:15 +01:00
Max Hilbrunner
da46470513 Merge pull request #6978 from JohnVeness/project-manager
Change capitalization of Project Manager
2023-03-20 02:45:09 +01:00
Max Hilbrunner
ecc80f3958 Merge pull request #6901 from m4gr3d/update_android_studio_dev_instructions
Add instructions for building and debugging using Android Studio
2023-03-20 01:06:46 +01:00
Fredia Huya-Kouadio
153d864db0 Add instructions for building and debugging using Android Studio 2023-03-19 09:40:08 -07:00
Justin McGettigan
7f7042c515 Updated instances of onready to @onready. 2023-03-18 16:06:11 -04:00
John Veness
08498ef96a Change capitalization of Project Manager 2023-03-13 20:08:49 +00:00
Hugo Locurcio
f658307ac7 Add a page on creating custom platform ports 2023-03-13 18:53:38 +01:00
Max Hilbrunner
12720dd582 Merge pull request #6888 from rcorre/compiledb
Document compiledb generation.
2023-03-09 05:03:19 +01:00
Ryan Roden-Corrent
009ca60f33 Document compiledb generation.
The compiledb=yes flag is only documented in the vscode and clion sections, but is relevant to any LSP-based editor.

In addition, nothing mentioned the ability to generate a compilation database without compiling, referenced here:

https://github.com/godotengine/godot/issues/39883#issuecomment-924423857
2023-03-04 07:32:55 -05:00
Hugo Locurcio
1abe518cf8 Mention local web server for testing web editor in Compiling/Exporting for the Web 2023-03-01 23:33:08 +01:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Max Hilbrunner
3592c269ac Merge pull request #6792 from RedworkDE/compiling-with-mono-net
Update the `Compiling with Mono` page
2023-02-26 10:06:15 +01:00
RedworkDE
6cdaa558a2 A lot of renames mono -> .NET
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2023-02-21 11:08:05 +01:00
RedworkDE
c7a776bbc7 Recommend dotnet --info, clarify Nuget caching 2023-02-20 20:24:57 +01:00
RedworkDE
8f585bfd84 Fix Python link typo in Compiling for Linux (#6794) 2023-02-20 18:41:56 +01:00
RedworkDE
4d78c82027 Rename page mono->dotnet, Doc build_assemblies args, Note about mono, Reviews, Fixes 2023-02-20 12:28:56 +01:00
RedworkDE
cab294b892 Update the Compiling with Mono page 2023-02-19 20:09:41 +01:00
anvilfolk
1631de89e7 Add --print-filenames option to GDScript unit testing (#6706)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2023-01-31 16:57:58 +01:00
Hugo Locurcio
9a361d1ecf Remove most mentions of SCons -j parameter as it's now set automatically
The Introduction to the buildsystem page still mentions this parameter
in case it needs to be changed, but in most situations, the default
value of `(number of CPU threads) - 1` does a good job.
2023-01-24 13:17:21 +01:00
Max Hilbrunner
be5ac7b34b Merge pull request #6648 from Calinou/compiling-linuxbsd-faster-linking
Document ways to further speed up linking in Compiling for Linux/*BSD
2023-01-23 17:19:46 +01:00
Hugo Locurcio
004654a114 Document ways to further speed up linking in Compiling for Linux/*BSD
mold and/or system libraries can be used to make iteration times
significantly faster when working on the engine.
2023-01-22 11:43:46 +01:00
Hugo Locurcio
14e4b0e110 Document using Pyston-lite for faster builds on macOS 2023-01-22 11:01:14 +01:00
Hugo Locurcio
554394c5cd Update Python version requirements on Compiling pages
The `master` branch has required Python 3.6 to be compiled for
a few years now.

This also makes the text more consistent across platforms.
2023-01-20 13:07:35 +01:00
Yuri Sizov
c337204562 Fix formatting issues reported by the builder 2023-01-14 17:40:27 +03:00
Yuri Sizov
6c08ab05d2 Split general debugging and architecture diagram documentation
Co-authored-by: CalebJohn <git@calebjohn.ca>
2023-01-10 03:26:04 +03:00
Yuri Sizov
dbfe3b1d26 Reorganize documentation for contributors
- Merge Community/Contributing and Engine Development into one top-level section, Contributing.
- Structure it in a way that gives equal priority to various ways to contribute, including documentation.
- Rename several articles to be more comprehensive and in line with the overall state of the documentation.
- Rewrite the guide for class reference contributions.
2023-01-10 01:49:30 +03:00