Skip to content

Commit 51d55cd

Browse files
committed
docs: specialize build for latest version
- leave only the latest version in versions list - remove conditions for previous versions - merge JVM7/8 source sets into JVM (cherry picked from commit 5a2d557)
1 parent 5e1e4ec commit 51d55cd

File tree

1 file changed

+73
-131
lines changed

1 file changed

+73
-131
lines changed

libraries/tools/kotlin-stdlib-docs/build.gradle.kts

+73-131
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,7 @@ fun createStdLibVersionedDocTask(version: String, isLatest: Boolean) =
6666
"kotlin.coroutines.jvm.internal",
6767
)
6868

69-
var kotlinLanguageVersion = version
70-
if (version == "1.0")
71-
kotlinLanguageVersion = "1.1"
72-
69+
val kotlinLanguageVersion = version
7370

7471
moduleName.set("kotlin-stdlib")
7572
val moduleDirName = "kotlin-stdlib"
@@ -86,30 +83,26 @@ fun createStdLibVersionedDocTask(version: String, isLatest: Boolean) =
8683
.put("org.jetbrains.dokka.kotlinlang.VersionFilterPlugin" , """{ "targetVersion": "$version" }""")
8784
}
8885
dokkaSourceSets {
89-
if (version != "1.0" && version != "1.1") { // Common platform since Kotlin 1.2
90-
register("common") {
91-
jdkVersion.set(8)
92-
platform.set(Platform.common)
93-
noJdkLink.set(true)
86+
register("common") {
87+
jdkVersion.set(8)
88+
platform.set(Platform.common)
89+
noJdkLink.set(true)
9490

95-
displayName.set("Common")
96-
sourceRoots.from("$kotlin_root/core/builtins/native")
97-
sourceRoots.from("$kotlin_root/core/builtins/src/")
91+
displayName.set("Common")
92+
sourceRoots.from("$kotlin_root/core/builtins/native")
93+
sourceRoots.from("$kotlin_root/core/builtins/src/")
9894

99-
sourceRoots.from("$kotlin_stdlib_dir/common/src")
100-
sourceRoots.from("$kotlin_stdlib_dir/src")
101-
sourceRoots.from("$kotlin_stdlib_dir/unsigned/src")
102-
}
95+
sourceRoots.from("$kotlin_stdlib_dir/common/src")
96+
sourceRoots.from("$kotlin_stdlib_dir/src")
97+
sourceRoots.from("$kotlin_stdlib_dir/unsigned/src")
10398
}
10499

105100
register("jvm") {
106101
jdkVersion.set(8)
107102
platform.set(Platform.jvm)
108103

109104
displayName.set("JVM")
110-
if (version != "1.0" && version != "1.1") {
111-
dependsOn("common")
112-
}
105+
dependsOn("common")
113106

114107
sourceRoots.from("$kotlin_stdlib_dir/jvm/src")
115108

@@ -120,85 +113,53 @@ fun createStdLibVersionedDocTask(version: String, isLatest: Boolean) =
120113
sourceRoots.from("$kotlin_stdlib_dir/jvm/runtime/kotlin/Throws.kt")
121114
sourceRoots.from("$kotlin_stdlib_dir/jvm/runtime/kotlin/TypeAliases.kt")
122115
sourceRoots.from("$kotlin_stdlib_dir/jvm/runtime/kotlin/text/TypeAliases.kt")
116+
sourceRoots.from("$kotlin_stdlib_dir/jdk7/src")
117+
sourceRoots.from("$kotlin_stdlib_dir/jdk8/src")
118+
}
119+
register("js") {
120+
jdkVersion.set(8)
121+
platform.set(Platform.js)
122+
noJdkLink.set(true)
123123

124-
// for Kotlin 1.0 and 1.1 hack: Common platform becomes JVM
125-
if (version == "1.0" || version == "1.1") {
124+
displayName.set("JS")
125+
if (version != "1.0" && version != "1.1") {
126+
dependsOn("common")
127+
}
128+
129+
sourceRoots.from("$kotlin_stdlib_dir/js/src")
130+
sourceRoots.from("$kotlin_stdlib_dir/js-v1/src")
131+
132+
// for Kotlin 1.1 hack: Common platform becomes JVM
133+
if (version == "1.1") {
126134
sourceRoots.from("$kotlin_root/core/builtins/native")
127135
sourceRoots.from("$kotlin_root/core/builtins/src/")
128136

129-
sourceRoots.from("$kotlin_stdlib_dir/common/src")
137+
//sourceRoots.from("$kotlin_stdlib_dir/common/src") // is included in /js-v1/src folder
130138
sourceRoots.from("$kotlin_stdlib_dir/src")
131139
sourceRoots.from("$kotlin_stdlib_dir/unsigned/src")
132140
}
141+
perPackageOption("org.w3c") {
142+
reportUndocumented.set(false)
143+
}
144+
perPackageOption("org.khronos") {
145+
reportUndocumented.set(false)
146+
}
133147
}
134-
if (version != "1.0" && version != "1.1") {
135-
register("jvm-jdk8") {
136-
jdkVersion.set(8)
137-
platform.set(Platform.jvm)
138-
139-
displayName.set("JVM8")
140-
dependsOn("jvm")
141-
dependsOn("common")
142-
sourceRoots.from("$kotlin_stdlib_dir/jdk8/src")
143-
}
144-
register("jvm-jdk7") {
148+
register("native") {
145149
jdkVersion.set(8)
146-
platform.set(Platform.jvm)
150+
platform.set(Platform.native)
151+
noJdkLink.set(true)
147152

148-
displayName.set("JVM7")
149-
dependsOn("jvm")
153+
displayName.set("Native")
150154
dependsOn("common")
151-
sourceRoots.from("$kotlin_stdlib_dir/jdk7/src")
152-
}
153-
}
154-
if (version != "1.0") { // JS platform since Kotlin 1.1
155-
register("js") {
156-
jdkVersion.set(8)
157-
platform.set(Platform.js)
158-
noJdkLink.set(true)
159-
160-
displayName.set("JS")
161-
if (version != "1.0" && version != "1.1") {
162-
dependsOn("common")
163-
}
164-
165-
sourceRoots.from("$kotlin_stdlib_dir/js/src")
166-
sourceRoots.from("$kotlin_stdlib_dir/js-v1/src")
167-
168-
// for Kotlin 1.1 hack: Common platform becomes JVM
169-
if (version == "1.1") {
170-
sourceRoots.from("$kotlin_root/core/builtins/native")
171-
sourceRoots.from("$kotlin_root/core/builtins/src/")
172-
173-
//sourceRoots.from("$kotlin_stdlib_dir/common/src") // is included in /js-v1/src folder
174-
sourceRoots.from("$kotlin_stdlib_dir/src")
175-
sourceRoots.from("$kotlin_stdlib_dir/unsigned/src")
176-
}
177-
perPackageOption("org.w3c") {
178-
reportUndocumented.set(false)
179-
}
180-
perPackageOption("org.khronos") {
181-
reportUndocumented.set(false)
182-
}
183-
}
184-
}
185-
if (version != "1.0" && version != "1.1" && version != "1.2") { // Native platform since Kotlin 1.3
186-
register("native") {
187-
jdkVersion.set(8)
188-
platform.set(Platform.native)
189-
noJdkLink.set(true)
190155

191-
displayName.set("Native")
192-
dependsOn("common")
193-
194-
sourceRoots.from("$kotlin_native_root/Interop/Runtime/src/main/kotlin")
195-
sourceRoots.from("$kotlin_native_root/Interop/Runtime/src/native/kotlin")
196-
sourceRoots.from("$kotlin_native_root/Interop/JsRuntime/src/main/kotlin")
197-
sourceRoots.from("$kotlin_native_root/runtime/src/main/kotlin")
198-
sourceRoots.from("$kotlin_stdlib_dir/native-wasm/src")
199-
perPackageOption("kotlin.test") {
200-
suppress.set(true)
201-
}
156+
sourceRoots.from("$kotlin_native_root/Interop/Runtime/src/main/kotlin")
157+
sourceRoots.from("$kotlin_native_root/Interop/Runtime/src/native/kotlin")
158+
sourceRoots.from("$kotlin_native_root/Interop/JsRuntime/src/main/kotlin")
159+
sourceRoots.from("$kotlin_native_root/runtime/src/main/kotlin")
160+
sourceRoots.from("$kotlin_stdlib_dir/native-wasm/src")
161+
perPackageOption("kotlin.test") {
162+
suppress.set(true)
202163
}
203164
}
204165
configureEach {
@@ -293,17 +254,15 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
293254
}
294255

295256
dokkaSourceSets {
296-
if (version != "1.0" && version != "1.1") { // Common platform since Kotlin 1.2
297-
register("common") {
298-
jdkVersion.set(8)
299-
platform.set(Platform.common)
300-
classpath.setFrom(kotlinTestCommonClasspath)
301-
noJdkLink.set(true)
302-
303-
displayName.set("Common")
304-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/common/src/main/kotlin")
305-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/annotations-common/src/main/kotlin")
306-
}
257+
register("common") {
258+
jdkVersion.set(8)
259+
platform.set(Platform.common)
260+
classpath.setFrom(kotlinTestCommonClasspath)
261+
noJdkLink.set(true)
262+
263+
displayName.set("Common")
264+
sourceRoots.from("$kotlin_root/libraries/kotlin.test/common/src/main/kotlin")
265+
sourceRoots.from("$kotlin_root/libraries/kotlin.test/annotations-common/src/main/kotlin")
307266
}
308267

309268
register("jvm") {
@@ -312,13 +271,8 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
312271
classpath.setFrom(kotlinTestJvmClasspath)
313272

314273
displayName.set("JVM")
315-
if (version != "1.0" && version != "1.1")
316-
dependsOn("common")
274+
dependsOn("common")
317275
sourceRoots.from("$kotlin_root/libraries/kotlin.test/jvm/src/main/kotlin")
318-
if (version == "1.0" || version == "1.1") {
319-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/common/src/main/kotlin")
320-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/annotations-common/src/main/kotlin")
321-
}
322276
}
323277

324278
register("jvm-JUnit") {
@@ -327,8 +281,7 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
327281
classpath.setFrom(kotlinTestJunitClasspath)
328282

329283
displayName.set("JUnit")
330-
if (version != "1.0" && version != "1.1")
331-
dependsOn("common")
284+
dependsOn("common")
332285
dependsOn("jvm")
333286
sourceRoots.from("$kotlin_root/libraries/kotlin.test/junit/src/main/kotlin")
334287

@@ -338,7 +291,6 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
338291
}
339292
}
340293

341-
if (version != "1.0" && version != "1.1")
342294
register("jvm-JUnit5") {
343295
jdkVersion.set(8)
344296
platform.set(Platform.jvm)
@@ -355,7 +307,6 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
355307
}
356308
}
357309

358-
if (version != "1.0" && version != "1.1")
359310
register("jvm-TestNG") {
360311
jdkVersion.set(8)
361312
platform.set(Platform.jvm)
@@ -371,31 +322,22 @@ fun createKotlinTestVersionedDocTask(version: String, isLatest: Boolean) =
371322
// packageListUrl.set(new URL("https://jitpack.io/com/github/cbeust/testng/master/javadoc/package-list"))
372323
// }
373324
}
374-
if (version != "1.0") { // JS platform since Kotlin 1.1
375-
register("js") {
376-
platform.set(Platform.js)
377-
classpath.setFrom(kotlinTestJsClasspath)
378-
noJdkLink.set(true)
379-
380-
displayName.set("JS")
381-
if (version != "1.1")
382-
dependsOn("common")
383-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/js/src/main/kotlin")
384-
if (version == "1.0" || version == "1.1") {
385-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/common/src/main/kotlin")
386-
sourceRoots.from("$kotlin_root/libraries/kotlin.test/annotations-common/src/main/kotlin")
387-
}
388-
}
325+
register("js") {
326+
platform.set(Platform.js)
327+
classpath.setFrom(kotlinTestJsClasspath)
328+
noJdkLink.set(true)
329+
330+
displayName.set("JS")
331+
dependsOn("common")
332+
sourceRoots.from("$kotlin_root/libraries/kotlin.test/js/src/main/kotlin")
389333
}
390-
if (version != "1.0" && version != "1.1" && version != "1.2") { // Native platform since Kotlin 1.3
391-
register("native") {
392-
platform.set(Platform.native)
393-
noJdkLink.set(true)
334+
register("native") {
335+
platform.set(Platform.native)
336+
noJdkLink.set(true)
394337

395-
displayName.set("Native")
396-
dependsOn("common")
397-
sourceRoots.from("$kotlin_native_root/runtime/src/main/kotlin/kotlin/test")
398-
}
338+
displayName.set("Native")
339+
dependsOn("common")
340+
sourceRoots.from("$kotlin_native_root/runtime/src/main/kotlin/kotlin/test")
399341
}
400342
configureEach {
401343
skipDeprecated.set(false)
@@ -447,7 +389,7 @@ fun GradleDokkaSourceSetBuilder.sourceLinksFromRoot() {
447389
}
448390

449391
gradle.projectsEvaluated {
450-
val versions = listOf("1.0", "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8")
392+
val versions = listOf(/*"1.0", "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7",*/ "1.8")
451393
val latestVersion = versions.last()
452394

453395
// builds this version/all versions as historical for the next versions builds

0 commit comments

Comments
 (0)