Skip to content

Commit 22f6ca8

Browse files
committed
Cleanup README
1 parent 7520c97 commit 22f6ca8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

core/kotlinx-coroutines-debug/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ Debugging facilities for `kotlinx.coroutines` on JVM.
44

55
### Overview
66

7-
This module provides a debug JVM agent which allows to track and trace alive coroutines.
8-
Main entry point to debug facilities is [DebugProbes].
7+
This module provides a debug JVM agent which allows to track and trace existing coroutines.
8+
The main entry point to debug facilities is [DebugProbes] API.
99
Call to [DebugProbes.install] installs debug agent via ByteBuddy and starts to spy on coroutines when they are created, suspended or resumed.
1010

11-
After that you can use [DebugProbes.dumpCoroutines] to print all active (suspended or running) coroutines, including their state, creation and
11+
After that, you can use [DebugProbes.dumpCoroutines] to print all active (suspended or running) coroutines, including their state, creation and
1212
suspension stacktraces.
13-
Additionally, it is possible to process list of such coroutines via [DebugProbes.dumpCoroutinesState] or dump isolated parts
14-
of coroutines hierarchies referenced by [Job] instance using [DebugProbes.printHierarchy].
13+
Additionally, it is possible to process the list of such coroutines via [DebugProbes.dumpCoroutinesState] or dump isolated parts
14+
of coroutines hierarchy referenced by a [Job] instance using [DebugProbes.printHierarchy].
1515

1616
### Using as JVM agent
1717

18-
Additionally, it is possible to use this module as standalone JVM agent to enable debug probes on the application startup.
19-
You can run your application with additional argument: `-javaagent:kotlinx-coroutines-debug-1.1.0.jar`.
18+
It is possible to use this module as a standalone JVM agent to enable debug probes on the application startup.
19+
You can run your application with an additional argument: `-javaagent:kotlinx-coroutines-debug-1.1.0.jar`.
2020
Additionally, on Linux and Mac OS X you can use `kill -5 $pid` command in order to force your application to print all alive coroutines.
2121

2222

0 commit comments

Comments
 (0)