Skip to content

Commit

Permalink
Documentation edits
Browse files Browse the repository at this point in the history
  • Loading branch information
apangin committed Jan 4, 2025
1 parent 0e3a7d7 commit 944dd40
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ to learn about more features.
### Nightly builds

[The most recent binaries](https://github.com/async-profiler/async-profiler/releases/tag/nightly) corresponding
to the latest successful commit in [`master`](https://github.com/async-profiler/async-profiler/commits/master/).
to the latest successful commit in `master`.

For a build corresponding to one of the previous commits, go to
[Nightly Builds](https://github.com/async-profiler/async-profiler/actions/workflows/test-and-publish-nightly.yml),
Expand Down
8 changes: 4 additions & 4 deletions docs/ConverterUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ as a standalone Java application: [`jfr-converter.jar`](https://github.com/async

## Supported conversions

| Source | html | collapsed | pprof | pb.gz | heatmap |
| Source | html | collapsed | pprof | pb.gz | heatmap |
| --------- | ---- | --------- | ----- | ----- | ------- |
| jfr ||||||
| html ||||||
| collapsed ||||||
| jfr ||||| |
| html ||||| |
| collapsed ||||| |

## Usage

Expand Down
16 changes: 8 additions & 8 deletions docs/CpuSamplingEngines.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ profiling interval is 10ms or 4ms respectively.

Here is a summary of advantages and drawbacks of all CPU profiling engines:

| Attribute | cpu (perf_events) | itimer | ctimer |
| --------- | :---: | :---: | :---: |
| Can collect kernel stack traces | | | |
| High resolution | | | |
| Accuracy / fairness | | | 🆗 |
| Works in containers by default | | | |
| Does not consume file descriptors | | | |
| macOS support | | | |
| Attribute | cpu (perf_events) | itimer | ctimer |
| --------------------------------- | :---------------: | :----: | :----: |
| Can collect kernel stack traces | | | |
| High resolution | | | |
| Accuracy / fairness | | | 🆗 |
| Works in containers by default | | | |
| Does not consume file descriptors | | | |
| macOS support | | | |

When using `-e cpu` on Linux, async-profiler automatically checks for `perf_events` availability
by trying to create a dummy perf_event. If kernel-space profiling is not available,
Expand Down

0 comments on commit 944dd40

Please sign in to comment.