[#267] Minor documentation update

CHANGELOG.md

@@ -1,5 +1,14 @@
 # gradle-pitest-plugin changelog
 
+## 1.9.11 - Unreleased
+
+ - Support for `verbosity` flag, "spinner" disabled by default - [#267](https://github.com/szpak/gradle-pitest-plugin/issues/267)
+ - Minimal supported PIT version is 1.7.1 (due to "verbosity" flag used by default)
+ - Deprecated `verbose` flag - `verbosity` is much more versatile, especially when used from the Gradle plugin
+
+**Compatibility notes**. Due to the usage of the "verbosity" flag by default, the minimal supported PIT version is 1.7.1 (released 2021-09-29)
+
+
 ## 1.9.0 - 2022-08-19
 
  - PIT 1.9.4 by default (requires pitest-junit5-plugin 1.0.0!)

README.md

@@ -293,7 +293,7 @@ in a `pitest` configuration closure.
 
 Please be aware that in some cases there could be some issues when using non default PIT versions.
 
-If not stated otherwise, gradle-pitest-plugin 1.9.x by default uses PIT 1.9.x, 1.7.x uses PIT 1.7.x, etc.
+If not stated otherwise, gradle-pitest-plugin 1.9.x by default uses PIT 1.9.x, 1.7.x uses PIT 1.7.x, etc. The minimal supported PIT version is 1.7.1.
 
 Starting with version 1.7.0 gradle-pitest-plugin requires Gradle 6.4. The latest version with the Gradle 5.x (5.6+) support is 1.6.0.
 The current version was automatically smoke tested with Gradle 6.4, 6.9.1 and 7.4.2 under Java 11.

src/funcTest/groovy/info/solidsoft/gradle/pitest/functional/PitestPluginPitVersionFunctionalSpec.groovy

@@ -39,11 +39,8 @@ class PitestPluginPitVersionFunctionalSpec extends AbstractPitestFunctionalSpec
     }
 
     private List<String> getPitVersionsCompatibleWithCurrentJavaVersion() {
-        return [getMinimalPitVersionCompatibleWithCurrentJavaVersion(), PitestPlugin.DEFAULT_PITEST_VERSION]
+        return [MINIMAL_SUPPORTED_PIT_VERSION, PitestPlugin.DEFAULT_PITEST_VERSION]
     }
 
-    private String getMinimalPitVersionCompatibleWithCurrentJavaVersion() {
-        return MINIMAL_SUPPORTED_PIT_VERSION
-    }
 
 }

src/main/groovy/info/solidsoft/gradle/pitest/PitestPluginExtension.groovy

@@ -94,8 +94,12 @@ class PitestPluginExtension {
      * <p>If false, the value of verbosity is used to determine the verbosity of the output.</p>
      * <p>Disabled by default.</p>
      *
+     * <p><b>Note:</b> This property is marked as deprecated as - in the majority of cases - it doesn't make sense to use it, if PIT is called using the Gradle
+     * plugin. Use #verosity instead.</p>
+     *
      * @see #verbosity
      */
+    @Deprecated //since GPP 1.9.11
     final Property<Boolean> verbose
 
     /**
@@ -112,9 +116,9 @@ class PitestPluginExtension {
      * <p><b>Note:</b> verbose must be set to false (which is the default) for this to have an effect.</p>
      *
      * @see #verbose
-     * @since 1.9.1
+     * @since 1.9.11
      */
-    final Property<String> verbosity //new in PIT 1.7.1 (GPP 1.9.1)
+    final Property<String> verbosity //new in PIT 1.7.1 (GPP 1.9.11)
     final Property<BigDecimal> timeoutFactor
     final Property<Integer> timeoutConstInMillis
     /**

src/test/groovy/info/solidsoft/gradle/pitest/PitestTaskConfigurationSpec.groovy

@@ -126,15 +126,15 @@ class PitestTaskConfigurationSpec extends BasicProjectBuilderSpec implements Wit
 
     void "should pass to PIT parameter 'verbosity' by default if not set explicitly"() {
         expect:
-        task.taskArgumentMap().containsKey('verbosity')
-        task.taskArgumentMap().get('verbosity').is('NO_SPINNER')
+            task.taskArgumentMap().containsKey('verbosity')
+            task.taskArgumentMap().get('verbosity').is('NO_SPINNER')
     }
 
     void "should pass to PIT parameter 'verbosity' if set explicitly"() {
         given:
-        project.pitest.verbosity = 'QUIET_WITH_PROGRESS'
+            project.pitest.verbosity = 'QUIET_WITH_PROGRESS'
         expect:
-        task.taskArgumentMap().get('verbosity').is('QUIET_WITH_PROGRESS')
+            task.taskArgumentMap().get('verbosity').is('QUIET_WITH_PROGRESS')
     }
 
     //TODO: Run PIT with those values to detect removed properties and typos