Skip to content

Commit 0fb716e

Browse files
committed
Replace generate_apk with generate_android_binaries in the Android documentation
1 parent 1b7b5bd commit 0fb716e

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

contributing/development/compiling/compiling_for_android.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -104,21 +104,21 @@ root directory with the following arguments:
104104
::
105105

106106
scons platform=android target=template_release arch=arm32
107-
scons platform=android target=template_release arch=arm64 generate_apk=yes
107+
scons platform=android target=template_release arch=arm64 generate_android_binaries=yes
108108

109109
- Debug template (used when exporting with **Debugging Enabled** checked)
110110

111111
::
112112

113113
scons platform=android target=template_debug arch=arm32
114-
scons platform=android target=template_debug arch=arm64 generate_apk=yes
114+
scons platform=android target=template_debug arch=arm64 generate_android_binaries=yes
115115

116116
- (**Optional**) Dev template (used when troubleshooting)
117117

118118
::
119119

120120
scons platform=android target=template_debug arch=arm32 dev_build=yes
121-
scons platform=android target=template_debug arch=arm64 dev_build=yes generate_apk=yes
121+
scons platform=android target=template_debug arch=arm64 dev_build=yes generate_android_binaries=yes
122122

123123
The resulting templates will be located under the ``bin`` directory:
124124

@@ -129,9 +129,11 @@ The resulting templates will be located under the ``bin`` directory:
129129

130130
.. note::
131131

132-
- If you are changing the list of architectures you're building, remember to add ``generate_apk=yes`` to the *last* architecture you're building, so that the template files are generated after the build.
132+
- If you are changing the list of architectures you're building, remember to add ``generate_android_binaries=yes`` to the *last* architecture you're building, so that the template files are generated after the build.
133133

134-
- To include debug symbols in the generated templates, add the ``debug_symbols=yes`` parameter to the SCons command.
134+
- To include debug symbols in the generated templates, add the ``debug_symbols=yes gradle_do_not_strip=yes`` parameters to the SCons command.
135+
136+
- Note that if you omit ``gradle_do_not_strip=yes``, the debug symbols will be included in a separate ``*-native-debug-symbols.zip`` file.
135137

136138
.. seealso::
137139

@@ -151,7 +153,7 @@ example, for the release template:
151153
scons platform=android target=template_release arch=arm32
152154
scons platform=android target=template_release arch=arm64
153155
scons platform=android target=template_release arch=x86_32
154-
scons platform=android target=template_release arch=x86_64 generate_apk=yes
156+
scons platform=android target=template_release arch=x86_64 generate_android_binaries=yes
155157

156158
This will create template binaries that works on all platforms.
157159
The final binary size of exported projects will depend on the platforms you choose
@@ -222,15 +224,17 @@ root directory with the following arguments:
222224
scons platform=android arch=arm32 production=yes target=editor
223225
scons platform=android arch=arm64 production=yes target=editor
224226
scons platform=android arch=x86_32 production=yes target=editor
225-
scons platform=android arch=x86_64 production=yes target=editor generate_apk=yes
227+
scons platform=android arch=x86_64 production=yes target=editor generate_android_binaries=yes
226228

227229
- You can add the ``dev_build=yes`` parameter to generate a dev build of the Godot editor.
228230

229-
- You can add the ``debug_symbols=yes`` parameter to include the debug symbols in the generated build.
231+
- You can add the ``debug_symbols=yes gradle_do_not_strip=yes`` parameters to include the debug symbols in the generated build.
232+
233+
- Note that if you omit ``gradle_do_not_strip=yes``, the debug symbols will be included in a separate ``*-native-debug-symbols.zip`` file.
230234

231235
- You can skip certain architectures depending on your target device to speed up compilation.
232236

233-
Remember to add ``generate_apk=yes`` to the *last* architecture you're building, so that binaries are generated after the build.
237+
Remember to add ``generate_android_binaries=yes`` to the *last* architecture you're building, so that binaries are generated after the build.
234238

235239
The resulting binaries will be located under ``bin/android_editor_builds/``.
236240

0 commit comments

Comments
 (0)