Skip to content

Commit 2a0b797

Browse files
committed
Improve README
1 parent b432db8 commit 2a0b797

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ Variants
6868
--------
6969
The JAR can be obtained in the following variants:
7070

71-
- `macos`, `linux-x64`, ...: `jattach`, `profiler.sh` and `libasyncProfiler.so` for the given platform
71+
- `macos`, `linux-x64`, ...: `jattach`, `profiler.sh`/`asprof` and `libasyncProfiler.so` for the given platform
7272
- `all`: all of the above
7373

74-
Regarding file sizes: The `all` variant are typically around 800KB and the individual variants around 200 to 400KB.
74+
Regarding file sizes: The `all` variant are` `typically around 800KB and the individual variants around 200 to 400KB.
7575

7676
Commands
7777
--------
@@ -99,7 +99,7 @@ Usage: java -jar ap-loader.jar <command> [args]
9999
Commands:
100100
help show this help
101101
jattach run the included jattach binary
102-
profiler run the included profiler.sh
102+
profiler run the included profiler.sh/asprof script
103103
agentpath prints the path of the extracted async-profiler agent
104104
jattachpath prints the path of the extracted jattach binary
105105
supported fails if this JAR does not include a profiler for the current OS and architecture
@@ -128,7 +128,7 @@ See the [GitHub page of jattach](https://github.com/apangin/jattach) for more de
128128
129129
### profiler
130130
131-
`java -jar ap-loader.jar profiler` is equivalent to calling the suitable `profiler.sh`:
131+
`java -jar ap-loader.jar profiler` is equivalent to calling the suitable `profiler.sh`/`asprof`:
132132
133133
```sh
134134
# Profile a process for `n` seconds

bin/releaser.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@
2020
from urllib import request
2121

2222
SUB_VERSION = 8
23-
RELEASE_NOTES = """- Drop dev.dirs:directories dependency #13 (thanks to @jsjant for spotting the potential licensing issue and fixing it in #14)
23+
RELEASE_NOTES = """- Support for [async-profiler 3.0](https://github.com/async-profiler/async-profiler/releases/tag/v3.0)
24+
- Breaking changes with async-profiler 3.0:
25+
- async-profiler 3.0 changed the meaning of the `--lib` option from `--lib path full path to libasyncProfiler.so in the container`
26+
to `-l, --lib prepend library names`, so the `AsyncProfilerLoader` will throw an UnsupportedOperation exception
27+
when using the `--lib` option with a path argument and async-profiler 3.0 or higher
2428
"""
2529

2630
HELP = """

0 commit comments

Comments
 (0)