From a650f0920843cb95f2deab08ee0ca45b071b6610 Mon Sep 17 00:00:00 2001
From: Sergey Rostov <Sergey.Rostov@jetbrains.com>
Date: Wed, 21 Nov 2018 10:55:03 +0300
Subject: [PATCH] JPS, tests: Add docs for incremental/cacheVersionChanged
 tests

Original commit: 06b908d48f11c2b457e1666c7af2d7054e8bc472
---
 .../AbstractDataContainerVersionChangedTest.kt   |  3 +++
 ...AbstractIncrementalCacheVersionChangedTest.kt |  3 +++
 .../incremental/cacheVersionChanged/README.md    | 16 ++++++++++++++++
 3 files changed, 22 insertions(+)
 create mode 100644 jps/jps-plugin/testData/incremental/cacheVersionChanged/README.md

diff --git a/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractDataContainerVersionChangedTest.kt b/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractDataContainerVersionChangedTest.kt
index 32307ce5d98..fa7076627e4 100644
--- a/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractDataContainerVersionChangedTest.kt
+++ b/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractDataContainerVersionChangedTest.kt
@@ -19,6 +19,9 @@ package org.jetbrains.kotlin.jps.build
 import org.jetbrains.kotlin.incremental.testingUtils.BuildLogFinder
 import org.jetbrains.kotlin.jps.targets.KotlinModuleBuildTarget
 
+/**
+ * @see [jps-plugin/testData/incremental/cacheVersionChanged/README.md]
+ */
 abstract class AbstractDataContainerVersionChangedTest : AbstractIncrementalCacheVersionChangedTest() {
     override val buildLogFinder: BuildLogFinder
         get() = BuildLogFinder(isDataContainerBuildLogEnabled = true)
diff --git a/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractIncrementalCacheVersionChangedTest.kt b/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractIncrementalCacheVersionChangedTest.kt
index 82d03db3c23..eb0a0b04272 100644
--- a/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractIncrementalCacheVersionChangedTest.kt
+++ b/jps/jps-plugin/jps-tests/test/org/jetbrains/kotlin/jps/build/AbstractIncrementalCacheVersionChangedTest.kt
@@ -21,6 +21,9 @@ import org.jetbrains.kotlin.incremental.testingUtils.ModifyContent
 import org.jetbrains.kotlin.jps.incremental.CacheVersionManager
 import org.jetbrains.kotlin.jps.targets.KotlinModuleBuildTarget
 
+/**
+ * @see [jps-plugin/testData/incremental/cacheVersionChanged/README.md]
+ */
 abstract class AbstractIncrementalCacheVersionChangedTest : AbstractIncrementalJpsTest(allowNoFilesWithSuffixInTestData = true) {
     override fun performAdditionalModifications(modifications: List<Modification>) {
         val modifiedFiles = modifications.filterIsInstance<ModifyContent>().map { it.path }
diff --git a/jps/jps-plugin/testData/incremental/cacheVersionChanged/README.md b/jps/jps-plugin/testData/incremental/cacheVersionChanged/README.md
new file mode 100644
index 00000000000..334e95185f1
--- /dev/null
+++ b/jps/jps-plugin/testData/incremental/cacheVersionChanged/README.md
@@ -0,0 +1,16 @@
+The same tests are run by both `AbstractIncrementalCacheVersionChangedTest` and `AbstractDataContainerVersionChangedTest`.
+
+## AbstractIncrementalCacheVersionChangedTest
+
+Tests for changing targets **local** cache version for each modification step.
+
+Individual tests can:
+- can skip changing the version at any step by adding files like `module1_do-not-change-cache-versions.new.2`
+- clear has-kotlin flag by adding files like `module1_clear-has-kotlin.new.1`
+
+## AbstractDataContainerVersionChangedTest
+
+Tests for changing version of **global** lookups cache for each modification step.
+Note that `build.log` file for this test case is named as `data-container-version-build.log`.
+
+Individual tests can can skip changing the version at any step by adding files like `module1_do-not-change-cache-versions.new.2`.
\ No newline at end of file