diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml index 8ae5dcbf5..f67383c30 100644 --- a/docs/cfg/buildprofiles.xml +++ b/docs/cfg/buildprofiles.xml @@ -1,5 +1,4 @@ - - - - - true - https://github.com/Kotlin/kotlinx-lincheck/edit/master/docs/ - true - - - + + + true + https://github.com/Kotlin/kotlinx-lincheck/edit/master/docs/ + true + + + \ No newline at end of file diff --git a/docs/kl.tree b/docs/kl.tree index 42e892db4..e51a2324b 100644 --- a/docs/kl.tree +++ b/docs/kl.tree @@ -1,18 +1,13 @@ - - - - - - - - - - - - - - - + + + + + + + + + + + + + diff --git a/docs/project.ihp b/docs/project.ihp deleted file mode 100644 index 6632192c3..000000000 --- a/docs/project.ihp +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/topics/constraints.md b/docs/topics/constraints.md index 0b1bcb91a..4865d796f 100644 --- a/docs/topics/constraints.md +++ b/docs/topics/constraints.md @@ -98,7 +98,7 @@ Note that all consuming `poll()` and `peek()` invocations are performed from a s > [Get the full code](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/MPSCQueueTest.kt). > -{type="note"} +{style="note"} ## Next step diff --git a/docs/topics/introduction.md b/docs/topics/introduction.md index db9eca3c1..4dab0b130 100644 --- a/docs/topics/introduction.md +++ b/docs/topics/introduction.md @@ -172,7 +172,7 @@ The updated `BasicCounterTest` class will look like this: > [Get the full code](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/BasicCounterTest.kt). > -{type="note"} +{style="note"} ## Test the Java standard library @@ -254,7 +254,7 @@ The following interleaving leads to the error: > [Get the full code](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/ConcurrentLinkedDequeTest.kt). > -{type="note"} +{style="note"} ## Next step diff --git a/docs/topics/operation-arguments.md b/docs/topics/operation-arguments.md index 3d7ad46e6..4d1b2fe1b 100644 --- a/docs/topics/operation-arguments.md +++ b/docs/topics/operation-arguments.md @@ -132,7 +132,7 @@ one of the values may be overwritten and lost. > [Get the full code](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/MultiMapTest.kt). > -{type="note"} +{style="note"} ## Next step diff --git a/docs/topics/progress-guarantees.md b/docs/topics/progress-guarantees.md index 5c857eaa0..53ee03178 100644 --- a/docs/topics/progress-guarantees.md +++ b/docs/topics/progress-guarantees.md @@ -98,7 +98,7 @@ class ConcurrentSkipListMapTest { > steps while a particular operation may be stuck. > * **obstruction-freedom**, when any operation is completed in a bounded number of steps if all the other threads pause. > -{type="tip"} +{style="tip"} At the moment, Lincheck supports only the obstruction-freedom progress guarantees. However, most real-life liveness bugs add unexpected blocking code, so the obstruction-freedom check will also help with lock-free and wait-free algorithms. @@ -107,7 +107,7 @@ add unexpected blocking code, so the obstruction-freedom check will also help wi > * See [another example](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/ObstructionFreedomViolationTest.kt) > where the Michael-Scott queue implementation is tested for progress guarantees. > -{type="note"} +{style="note"} ## Next step diff --git a/docs/topics/sequential-specification.md b/docs/topics/sequential-specification.md index 16f8794fd..882c05e80 100644 --- a/docs/topics/sequential-specification.md +++ b/docs/topics/sequential-specification.md @@ -5,7 +5,7 @@ by writing a straightforward sequential implementation of the testing data struc > This feature also allows you to write a single test instead of two separate sequential and concurrent tests. > -{type="tip"} +{style="tip"} To provide a sequential specification of the algorithm for verification: @@ -51,4 +51,4 @@ class SequentialQueue { > Get the [full code of the examples](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/ConcurrentLinkedQueueTest.kt). > -{type="note"} \ No newline at end of file +{style="note"} \ No newline at end of file diff --git a/docs/topics/testing-strategies.md b/docs/topics/testing-strategies.md index 5e2f121aa..2b2572c49 100644 --- a/docs/topics/testing-strategies.md +++ b/docs/topics/testing-strategies.md @@ -48,7 +48,7 @@ class CounterTest { } ``` -### How stress testing works {initial-collapse-state="collapsed"} +### How stress testing works {initial-collapse-state="collapsed" collapsible="true"} At first, Lincheck generates a set of concurrent scenarios using the operations marked with `@Operation`. Then it launches native threads, synchronizing them at the beginning to guarantee that operations start simultaneously. Finally, Lincheck @@ -93,7 +93,7 @@ class CounterTest { } ``` -### How model checking works {initial-collapse-state="collapsed"} +### How model checking works {initial-collapse-state="collapsed" collapsible="true"} Most bugs in complicated concurrent algorithms can be reproduced with classic interleavings, switching the execution from one thread to another. Besides, model checkers for weak memory models are very complicated, @@ -270,7 +270,7 @@ as well as at the end. > * Get the [full code of these examples](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/CounterTest.kt) > * See more [test examples](https://github.com/Kotlin/kotlinx-lincheck/blob/guide/src/jvm/test/org/jetbrains/kotlinx/lincheck/test/guide/StackTest.kt) > -{type="note"} +{style="note"} ## Next step diff --git a/docs/writerside.cfg b/docs/writerside.cfg new file mode 100644 index 000000000..41dfe9d62 --- /dev/null +++ b/docs/writerside.cfg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + +