Skip to content

Commit 5030fe5

Browse files
committed
Minor documentation edits
1 parent bc80518 commit 5030fe5

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

docs/Heatmap.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ retain stacks with matching frames only. All other stacks will be filtered out.
7979

8080
![](/.assets/images/heatmap6.png)
8181

82-
### Producing heatmaps
82+
## Producing heatmaps
8383

84-
Use [`jfrconv`](ConverterUsage.md) tool with `-o heatmap` option
85-
to generate heatmap from a recording in JFR format.
84+
Heatmaps can only be generated from recordings in JFR format.
85+
Run [`jfrconv`](ConverterUsage.md) tool with `-o heatmap` option.
8686

8787
Standard `jfrconv` options (`--cpu`, `--alloc`, `--from`/`--to`, `--simple`, etc.)
8888
are also applicable to heatmaps.

docs/ProfilerOptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The below options are `action`s for async-profiler and common for both `asprof`
3737
| `--nativemem N` | `nativemem=N` | Native memory allocation profiling. N, if specified is the interval in bytes or in other units, if N is followed by `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). Default N is 0. |
3838
| `--nofree` | `nofree` | Will not record free calls in native memory allocation profiling. This is relevant when tracking memory leaks is not important and there are lots of free calls. |
3939
| `--lock DURATION` | `lock=DURATION` | In lock profiling mode, sample contended locks when total lock duration overflows the threshold. |
40+
| `--wall INTERVAL` | `wall=INTERVAL` | Wall clock profiling interval. Use this option instead of `-e wall` to enable wall clock profiling with another event, typically `cpu`.<br>Example: `asprof -e cpu --wall 100ms -f combined.jfr 8983`. |
4041
| `-j N` | `jstackdepth=N` | Sets the maximum stack depth. The default is 2048.<br>Example: `asprof -j 30 8983` |
4142
| `-I PATTERN` | `include=PATTERN` | Filter stack traces by the given pattern(s). `-I` defines the name pattern that _must_ be present in the stack traces. `-I` can be specified multiple times. A pattern may begin or end with a star `*` that denotes any (possibly empty) sequence of characters.<br>Example: `asprof -I 'Primes.*' -I 'java/*' 8983` |
4243
| `-X PATTERN` | `exclude=PATTERN` | Filter stack traces by the given pattern(s). `-X` defines the name pattern that _must not_ occur in any of stack traces in the output. `-X` can be specified multiple times. A pattern may begin or end with a star `*` that denotes any (possibly empty) sequence of characters.<br>Example: `asprof -X '*Unsafe.park*' 8983` |

docs/ProfilingModes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Run an application with `nativemem` profiler that dumps recordings in JFR format
136136
LD_PRELOAD=/path/to/libasyncProfiler.so ASPROF_COMMAND=start,nativemem,total,loop=10m,cstack=dwarf,file=profile-%t.jfr NativeApp [args]
137137
```
138138

139-
Then run `jfrconv` to generate memory leak reports as flame graphs:
139+
Then run `jfrconv` to generate memory leak report as a flame graph:
140140

141141
```
142142
jfrconv --total --nativemem --leak <profile>.jfr <profile>-leak.html

src/main/main.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,8 @@ int main(int argc, const char** argv) {
493493
} else if (arg == "--width" || arg == "--height" || arg == "--minwidth") {
494494
format << "," << (arg.str() + 2) << "=" << args.next();
495495

496-
} else if (arg == "--reverse" || arg == "--inverted" || arg == "--samples" || arg == "--total" || arg == "--sched" || arg == "--live" || arg == "--nofree") {
496+
} else if (arg == "--reverse" || arg == "--inverted" || arg == "--samples" || arg == "--total" ||
497+
arg == "--sched" || arg == "--live" || arg == "--nofree") {
497498
format << "," << (arg.str() + 2);
498499

499500
} else if (arg == "--alloc" || arg == "--nativemem" || arg == "--lock" || arg == "--wall" ||

0 commit comments

Comments
 (0)