Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Writeside Migration (Test PR) #371

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions docs/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
~ Lincheck
~
Expand All @@ -9,12 +8,11 @@
~ Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
~ with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<buildprofiles>
<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/Kotlin/kotlinx-lincheck/edit/master/docs/</browser-edits-url>
<allow-indexable-eaps>true</allow-indexable-eaps>
</variables>
<build-profile product="kl"/>
</buildprofiles>
<buildprofiles xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd">
<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/Kotlin/kotlinx-lincheck/edit/master/docs/</browser-edits-url>
<allow-indexable-eaps>true</allow-indexable-eaps>
</variables>
<build-profile instance="kl"/>
</buildprofiles>
31 changes: 13 additions & 18 deletions docs/kl.tree
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE product-profile
SYSTEM "https://resources.jetbrains.com/stardust/product-profile.dtd">

<product-profile id="kl"
name="kotlinx-lincheck"
start-page="lincheck-guide.md">

<chunk include-id="lincheck">
<toc-element id="lincheck-guide.md"/>
<toc-element id="introduction.md"/>
<toc-element id="testing-strategies.md" toc-title="Testing strategies"/>
<toc-element id="operation-arguments.md"/>
<toc-element id="constraints.md"/>
<toc-element id="progress-guarantees.md"/>
<toc-element id="sequential-specification.md"/>
</chunk>
</product-profile>
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE instance-profile SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
<instance-profile id="lincheck" name="kotlinx-lincheck" start-page="lincheck-guide.md">
<snippet id="lincheck">
<toc-element topic="lincheck-guide.md"/>
<toc-element topic="introduction.md"/>
<toc-element toc-title="Testing strategies" topic="testing-strategies.md"/>
<toc-element topic="operation-arguments.md"/>
<toc-element topic="constraints.md"/>
<toc-element topic="progress-guarantees.md"/>
<toc-element topic="sequential-specification.md"/>
</snippet>
</instance-profile>
14 changes: 0 additions & 14 deletions docs/project.ihp

This file was deleted.

2 changes: 1 addition & 1 deletion docs/topics/constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/topics/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/operation-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/progress-guarantees.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/topics/sequential-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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"}
{style="note"}
6 changes: 3 additions & 3 deletions docs/topics/testing-strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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

Expand Down
15 changes: 15 additions & 0 deletions docs/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
<ihp version="2.0">
<!-- <categories src="c.list"/> -->
<module name="lincheck"/>
<topics dir="topics"/>
<images dir="images"/>
<vars src="v.list"/>
<settings>
<default-property element-name="toc-element" property-name="show-structure-depth" value="2"/>
<wrs-supernova use-version="2.1.1946-p6630"/>
<propbundle-cache type="file" location="file:properties/propmap-dominators.xml" enabled="true"/>
</settings>
<instance src="kl.tree" version="1.0"/>
</ihp>