Skip to content

Commit 922ecd9

Browse files
committed
added android specific instructions
1 parent 89f12f8 commit 922ecd9

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

doc/dev_guide/platform_specific_instructions.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ In case you are having a local build failure on macOS due to "audio_session" do
2727

2828
## Android (Work in Progress)
2929

30+
- If any case targeting the Android API level below 21 or the project and the libraries it references exceed 65,536 methods, you encounter the following build error that indicates your app has reached the limit of the Android build architecture:
31+
```
32+
trouble writing output:
33+
Too many field references: 131000; max is 65536.
34+
You may try using --multi-dex option.
35+
```
36+
OR
37+
```
38+
Conversion to Dalvik format failed:
39+
Unable to execute dex: method ID not in [0, 0xffff]: 65536
40+
```
41+
To solve this problem,
3042
Add the `multiDexEnabled true` line to the `defaultConfig` section at `android/app/build.gradle file`
3143

3244
```
@@ -39,7 +51,33 @@ android {
3951
}
4052
```
4153

42-
For more information on multidex support, you can refer to the Android developer guide on [Configuring Multidex](https://developer.android.com/studio/build/multidex).
54+
For more information on multidex support, you can refer to the Android developer guide on [Configuring Multidex](https://developer.android.com/studio/build/multidex).
55+
56+
- If you are experiencing build failure issues while debugging due to Gradle/JDK/AGP version resolving try the following
57+
upgrading gradle version by CLI command
58+
```
59+
gradle wrapper --gradle-version <latest compatible version>
60+
```
61+
In any case above command fails then you need to edit the Gradle distribution reference in the `gradle/wrapper/gradle-wrapper.properties` file. The following example sets the Gradle version to 8.8 in the `gradle-wrapper.properties` file.
62+
```
63+
...
64+
distributionUrl = https\://services.gradle.org/distributions/gradle-8.8-bin.zip
65+
...
66+
```
67+
upgrade AGP by specifying the plugin version in the top-level `build.gradle` file. The following example sets the plugin to version 8.8.0 from the `build.gradle` file:
68+
```
69+
plugins {
70+
...
71+
id 'com.android.application' version '8.8.0' apply false
72+
id 'com.android.library' version '8.8.0' apply false
73+
...
74+
}
75+
76+
```
77+
For more information on Gradle and Java version compatibility, you can refer to [Compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html).
78+
For more information on Gradle and Android Gradle Plugin compatibility, you can refer to [Update Gradle](https://developer.android.com/build/releases/gradle-plugin).
79+
Note : It is highly recommended that always ensure gradle and agp versions are compatible with your JDK version not the vice-versa and having atleast JDK 17 is recommmended.
80+
4381

4482
## Web
4583

0 commit comments

Comments
 (0)