Skip to content

Commit abe3c13

Browse files
committed
~ Remove a separate knit module and dir
1 parent 795b241 commit abe3c13

9 files changed

+34
-47
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,12 @@ The `develop` branch is pushed to `master` during release.
217217

218218
* Full release procedure checklist is [here](RELEASE.md).
219219
* Steps for contributing new integration modules are explained [here](integration/README.md#Contributing).
220+
* Use [Knit](https://github.com/Kotlin/kotlinx-knit/blob/master/README.md) for updates to documentation:
221+
* In project root directory run `./gradlew knit`.
222+
* Commit updated documents and examples together with other changes.
223+
* Use [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator/blob/master/README.md) for updates to public API:
224+
* In project root directory run `./gradlew apiDump`.
225+
* Commit updated API index together with other changes.
220226

221227
<!--- MODULE kotlinx-coroutines-core -->
222228
<!--- INDEX kotlinx.coroutines -->

build.gradle

+14-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ apply from: rootProject.file("gradle/experimental.gradle")
88
def rootModule = "kotlinx.coroutines"
99
def coreModule = "kotlinx-coroutines-core"
1010
// Not applicable for Kotlin plugin
11-
def sourceless = ['kotlinx.coroutines', 'site', 'kotlinx-coroutines-bom', 'knit']
12-
def internal = ['kotlinx.coroutines', 'site', 'benchmarks', 'knit', 'js-stub', 'stdlib-stubs']
11+
def sourceless = ['kotlinx.coroutines', 'site', 'kotlinx-coroutines-bom']
12+
def internal = ['kotlinx.coroutines', 'site', 'benchmarks', 'js-stub', 'stdlib-stubs']
1313
// Not published
1414
def unpublished = internal + ['example-frontend-js', 'android-unit-tests']
1515

@@ -131,7 +131,7 @@ allprojects {
131131

132132
apply plugin: "binary-compatibility-validator"
133133
apiValidation {
134-
ignoredProjects += ["stdlib-stubs", "benchmarks", "knit", "site",
134+
ignoredProjects += ["stdlib-stubs", "benchmarks", "site",
135135
"kotlinx-coroutines-bom", "android-unit-tests", "js-stub"]
136136
ignoredPackages += "kotlinx.coroutines.internal"
137137
}
@@ -274,3 +274,14 @@ task deploy(dependsOn: getTasksByName("publish", true) + getTasksByName("publish
274274
apply plugin: 'base'
275275

276276
clean.dependsOn gradle.includedBuilds.collect { it.task(':clean') }
277+
278+
// --------------- Knit configuration ---------------
279+
280+
apply plugin: 'kotlinx-knit'
281+
282+
knit {
283+
siteRoot = "https://kotlin.github.io/kotlinx.coroutines"
284+
moduleRoots = [".", "integration", "reactive", "ui"]
285+
}
286+
287+
knitPrepare.dependsOn getTasksByName("dokka", true)
File renamed without changes.

docs/knit.properties

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
#
2-
# Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
2+
# Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
33
#
44

55
knit.package=kotlinx.coroutines.guide
66
knit.dir=../kotlinx-coroutines-core/jvm/test/guide/
7+
knit.pattern=example-[a-zA-Z0-9-]+-##\\.kt
8+
knit.include=knit.code.include
79

810
test.package=kotlinx.coroutines.guide.test
911
test.dir=../kotlinx-coroutines-core/jvm/test/guide/test/
12+
test.template=knit.test.template
13+
14+
# Various test validation modes and their corresponding methods from TestUtil
15+
test.mode.=verifyLines
16+
test.mode.STARTS_WITH=verifyLinesStartWith
17+
test.mode.ARBITRARY_TIME=verifyLinesArbitraryTime
18+
test.mode.FLEXIBLE_TIME=verifyLinesFlexibleTime
19+
test.mode.FLEXIBLE_THREAD=verifyLinesFlexibleThread
20+
test.mode.LINES_START_UNORDERED=verifyLinesStartUnordered
21+
test.mode.LINES_START=verifyLinesStart
22+
test.mode.EXCEPTION=verifyExceptions
File renamed without changes.

knit.properties

-18
This file was deleted.

knit/README.md

-11
This file was deleted.

knit/build.gradle

-13
This file was deleted.

settings.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ def module(String path) {
1515
// ---------------------------
1616

1717
include('benchmarks')
18-
include('knit')
1918
include('site')
2019

2120
include "kotlinx-coroutines-core"

0 commit comments

Comments
 (0)