Skip to content

Commit

Permalink
doc: wrap.
Browse files Browse the repository at this point in the history
Because if the docs are for an awful thing, it doesn't mean they have
to look awful as well.
  • Loading branch information
mosra committed Nov 11, 2020
1 parent c5a9d2b commit 6f1f50d
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions doc/platforms-android.dox
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,8 @@ If you see the following warning when building with Android Gradle Plugin 3.6.0
and newer, it's because an @cb{.sh} $ANDROID_NDK_HOME @ce environment variable
is defined.

@m_class{m-console-wrap}

@code{.shell-session}
$ gradle build

Expand Down Expand Up @@ -940,6 +942,8 @@ android {
will result in the following error, or worse, a
@ref platforms-android-troubleshooting-no-signature-applicable "cryptic error about some closure".

@m_class{m-console-wrap}

@code{.shell-session}
> Specified android.ndkVersion '19' does not have enough precision. Use major.minor.micro in version.
@endcode
Expand Down Expand Up @@ -983,6 +987,8 @@ gradle build
You can also put that directly into the `gradle.build` file, although that's
not recommended because it hardcodes your local system setup in the project:

@m_class{m-console-wrap}

@code{.gradle}
android {
...
Expand Down Expand Up @@ -1089,20 +1095,26 @@ but why is that reported by a throwing exception 1000 stack frames deep in some
totally random ungoogleable API is just beyond me. Anyway --- the following
may happen with Android Gradle plugin 2.3.3:

@m_class{m-console-wrap}

@code{.shell-session}
> Failed to notify project evaluation listener.
> org.gradle.api.tasks.compile.CompileOptions.setBootClasspath(Ljava/lang/String;)V
@endcode

While this with 3.0.0:

@m_class{m-console-wrap}

@code{.shell-session}
> Failed to notify project evaluation listener.
> org.gradle.api.internal.TaskInputsInternal.property(Ljava/lang/String;Ljava/lang/Object;)Lorg/gradle/api/tasks/TaskInputs;
@endcode

This for 3.3.0:

@m_class{m-console-wrap}

@code{.shell-session}
> Failed to notify project evaluation listener.
> org.gradle.api.file.ProjectLayout.directoryProperty(Lorg/gradle/api/provider/Provider;)Lorg/gradle/api/file/DirectoryProperty;
Expand All @@ -1128,6 +1140,8 @@ buildscript {
Android Gradle plugin 3.6 and newer may *greet* you with the following when
doing a fresh build:

@m_class{m-console-wrap}

@code{.shell-session}
$ gradle build

Expand Down Expand Up @@ -1177,6 +1191,8 @@ keep it there.
Gradle might refuse to build a project if SDK licenses are not accepted, with
an error that might look like this:

@m_class{m-console-wrap}

@code{.shell-session}
$ gradle build

Expand Down Expand Up @@ -1209,6 +1225,8 @@ If the tool blows up with the following error, it's again because the Java
version is too new, see @ref platforms-android-troubleshooting-java8 "above"
for a solution:

@m_class{m-console-wrap}

@code{.shell-session}
Exception in thread "main" java.lang.NoClassDefFoundError: javax/xml/bind/annotation/XmlSchema
at com.android.repository.api.SchemaModule$SchemaModuleVersion.<init>(SchemaModule.java:156)
Expand All @@ -1217,6 +1235,8 @@ Exception in thread "main" java.lang.NoClassDefFoundError: javax/xml/bind/annota

@subsection platforms-android-troubleshooting-marshalling-nonexistent-xml Gradle complains about an exception while marshalling some XML file that doesn't exist

@m_class{m-console-wrap}

@code{.shell-session}
$ gradle build

Expand All @@ -1233,6 +1253,8 @@ if there are no licenses left to sign.

@subsection platforms-android-troubleshooting-no-signature-applicable Gradle fails because no signature of method is applicable for argument types

@m_class{m-console-wrap}

@code{.shell-session}
$ gradle build

Expand Down Expand Up @@ -1268,8 +1290,8 @@ and [android-platform-25](https://aur.archlinux.org/packages/android-platform-25
@section platforms-android-obsolete-troubleshooting Obsolete troubleshooting

These issues should no longer appear in practice with reasonably recent
versions of Android tools, however are still kept <del>to remind us everything
used to be even worse than it is now</del> in case your project keeps using the
versions of Android tools, however are still kept <s>to remind us everything
used to be even worse than it is now</s> in case your project keeps using the
older versions (which is recommended for sanity, there's not many things worse
than upgrading Android NDK).

Expand Down

0 comments on commit 6f1f50d

Please sign in to comment.