Skip to content

Commit 6cde9f7

Browse files
Address comments for Converter usage chapter.
1 parent 2a10b21 commit 6cde9f7

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

docs/ConverterUsage.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,25 @@ Conversion options:
1313
-o --output FORMAT Output format: <filename> followed by any of the extensions: html, collapsed, pprof, pb.gz
1414
1515
JFR options:
16-
--cpu CPU profile
17-
--wall Wall clock profile
18-
--alloc Allocation profile
19-
--live Live object profile
20-
--lock Lock contention profile
16+
--cpu Generate only CPU profile during conversion
17+
--wall Generate only Wall clock profile during conversion
18+
--alloc Generate only Allocation profile during conversion
19+
--live Build allocation profile from live objects only during conversion
20+
--lock Generate only Lock contention profile during conversion
2121
-t --threads Split stack traces by threads
2222
-s --state LIST Filter thread states: runnable, sleeping
2323
--classify Classify samples into predefined categories
24-
--total Accumulate total value (time, bytes, etc.)
24+
--total Accumulate total value (time, bytes, etc.) instead of samples
2525
--lines Show line numbers
2626
--bci Show bytecode indices
27-
--simple Simple class names instead of FQN
28-
--norm Normalize names of hidden classes / lambdas
29-
--dot Dotted class names
27+
--simple Simple class names instead of fully qualified names
28+
--norm Normalize names of hidden classes/lambdas
29+
--dot Dotted class names instead of / notation
3030
--from TIME Start time in ms (absolute or relative)
3131
--to TIME End time in ms (absolute or relative)
3232
3333
Flame Graph options:
34-
--title STRING Flame Graph title
34+
--title STRING Convert to Flame Graph with provided title
3535
--minwidth X Skip frames smaller than X%
3636
--grain X Coarsen Flame Graph to the given grain size
3737
--skip N Skip N bottom frames
@@ -87,12 +87,12 @@ These are few common use cases. Similarly, a JFR output can be converted to `col
8787

8888
### Example usages with `jfr-converter.jar`
8989

90-
The usage with `convereter.jar` provided in
90+
The usage with `jfr-convereter.jar` provided in
9191
[Download](https://github.com/async-profiler/async-profiler/?tab=readme-ov-file#Download)
9292
section is very similar to `jfrconv`.
9393

9494
Let's look at an example usage.
9595

96-
`java -cp /path/to/converter.jar --cpu foo.jfr --reverse --title Title`
96+
`java -cp /path/to/jfr-converter.jar --cpu foo.jfr --reverse --title Title`
9797

9898
As we can see, the only difference lies in how the binary is used.

0 commit comments

Comments
 (0)