Skip to content

Commit 675e339

Browse files
authored
feat(godot): Refine Readable Stack Traces guide (#13000)
* feat: Refine Godot Stack Trace guide - Update screenshot. - Add better instructions for macOS. * Fix code tabs
1 parent 98d0491 commit 675e339

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed
37.3 KB
Loading

docs/platforms/godot/configuration/stack-traces.mdx

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Learn how to get traces with line numbers and file paths in Sentry
55

66
[The official Godot Engine builds only provide templates without debug information files](https://github.com/godotengine/godot-proposals/issues/1342). This guide covers how to create such templates and use them to export your project with full debug information available in Sentry.
77

8-
Debug information files allow Sentry to extract stack traces and provide additional information from crash reports. In order to get stack traces that contain function names, line numbers and file paths, Sentry needs to have these debug information files available when processing the crash dumps. For that, you need to export your Godot project using an export template that contains debug information.
8+
Debug information files allow Sentry to extract stack traces and provide additional information from crash reports. In order to get stack traces that contain function names, line numbers and file paths, Sentry needs to have these debug information files available when processing the crash dumps. For that, you need to export your Godot project using an export template that contains debug information.
99

1010
## Prerequisites
1111

@@ -60,23 +60,29 @@ git checkout 4.4-stable
6060

6161
To compile the Godot release export template with debug symbols, run the following command:
6262

63-
```bash
64-
scons platform=windows target=template_release production=yes debug_symbols=yes separate_debug_symbols=yes
63+
```bash {tabTitle:Windows/Linux}
64+
scons target=template_release production=yes debug_symbols=yes separate_debug_symbols=yes
65+
```
66+
67+
```bash {tabTitle:macOS}
68+
scons target=template_release arch=x86_64 production=yes debug_symbols=yes separate_debug_symbols=yes platform=macos
69+
scons target=template_release arch=arm64 generate_bundle=yes production=yes debug_symbols=yes separate_debug_symbols=yes platform=macos
6570
```
6671

6772
<Expandable title="Options explained">
6873

69-
- `platform`: target platform (e.g., "windows", "linux", or "macos")
7074
- `target`: compilation target (e.g., "editor" or "template_release")
71-
- `production`: sets build defaults for production use
72-
- `debug_symbols`: includes debugging symbols in the build
73-
- `separate_debug_symbols`: extracts symbols into a separate file
75+
- `arch`: architecture to compile for (e.g., "x86_64" or "arm64")
76+
- `production`: set build defaults for production use
77+
- `debug_symbols`: include debugging symbols in the build
78+
- `separate_debug_symbols`: extract symbols into a separate file
79+
- `generate_bundle`: generate an APP bundle `godot_macos.zip` after building macOS binaries
7480

7581
For more information, run: `scons --help`
7682

7783
</Expandable>
7884

79-
If all goes well, the export template files should appear as the result of the build process in the `bin/` directory inside the Godot source tree. When using MSVC on Windows, you will find `.exe` files alongside `.pdb` files, which contain debug information.
85+
If all goes well, the export template files should appear as the result of the build process in the `bin/` directory inside the Godot source tree. When using MSVC on Windows, you will find `.exe` files alongside `.pdb` files, which contain debug information. On macOS, you will find `godot_macos.zip` containing a universal binary supporting both x86_64 and ARM64 architectures and also two folders ending with `.dSYM` containing debug information bundles for each architecture.
8086

8187
<Alert>
8288

0 commit comments

Comments
 (0)