diff --git a/docs/configuration.md b/docs/configuration.md index be6d5e41..eb11ab2a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -34,7 +34,11 @@ * Do not allow building all apps simultaneously. This is likely not what the user intended. */ allowBuildingAllAndroidAppsSimultaneously = false - + /** + * Warn if using Android Jetifier. It slows down builds. + */ + warnWhenJetifierEnabled = true + /** Configuration properties relating to JAVA_HOME */ javaHome { /** @@ -58,7 +62,7 @@ } ``` === "Kotlin" - ``` groovy + ``` kotlin configure { /** * Throw an exception when multiple Gradle Daemons are running. @@ -89,7 +93,11 @@ * Do not allow building all apps simultaneously. This is likely not what the user intended. */ allowBuildingAllAndroidAppsSimultaneously.set(false) - + /** + * Warn if using Android Jetifier. It slows down builds. + */ + warnWhenJetifierEnabled.set(true) + /** Configuration properties relating to JAVA_HOME */ javaHome { /** diff --git a/docs/index.md b/docs/index.md index 9ac2c8d6..b39a1d66 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,17 +6,22 @@ The right prescription for your Gradle build. Watch this Virtual Android Makers 2019 entitled [The Secrets of the Build Scan Plugin and the Internals of Gradle](https://www.youtube.com/watch?v=lgaqS0pmUzk) to learn more about what this plugin does. ## Usage - -``` groovy -buildscript { - dependencies { - classpath "com.osacky.doctor:doctor-plugin:{{ doctor.current_release }}" - } -} - -// Must be applied in the project root. -apply plugin: "com.osacky.doctor" -``` +1. Apply the Gradle Plugin to the root of your project. +2. The Gradle Doctor will print suggestions for your build as you run regular tasks. + +=== "Groovy" + ``` groovy + plugins { + id "com.osacky.doctor" version "0.5.1" + } + ``` +=== "Kotlin" + ``` kotlin + plugins { + id("com.osacky.doctor") version "0.5.1" + } + ``` +[For legacy plugin application, see the Gradle Plugin Portal.](https://plugins.gradle.org/plugin/com.osacky.doctor) ## Features * Configurable warnings for build speed problems @@ -26,6 +31,7 @@ apply plugin: "com.osacky.doctor" * Disable assembling all apps in repository simultaneously. * Fail build when empty src directories are found. [Empty src directories](https://github.com/gradle/gradle/issues/2463) cause [cache misses](https://developers.soundcloud.com/blog/dagger-reflect). * [Benchmarking remote build cache connection speed](remote-cache). +* [Warnings for negative avoidance saving tasks.](slower-from-cache) ### Configurable Warnings * Warn when build spends more than 10% of the time garbage collecting.