Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jolynch committed Apr 16, 2024
1 parent 8fc3471 commit bd63a7f
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Build Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)
[![CI Build Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml)

# `jvmquake`
A JVMTI agent that attaches to your JVM and automatically signals and kills it
Expand Down Expand Up @@ -185,7 +185,8 @@ specification. In practice I find the same `.so` works fine with Java 8, 9, 11
and I imagine it will work until Java changes the spec.

See [Testing](#Testing) for the full set of platforms that we test against.
![Build Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)

[![Build Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml)

## How to Use the Agent
Once you have the agent library, run your java program with `agentpath` or `agentlib`
Expand Down Expand Up @@ -272,6 +273,17 @@ handles.

## Automated Tests

[![Test Suite Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml)

Note that the compiled `libjvmquake.so` does not link against JVM libraries,
so it _should be portable_ to any instance running on the same architecture:
```
$ ldd build/libjvmquake-linux-x86_64.so
linux-vdso.so.1 (0x00007ffd2c1c2000)
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007b5ed4400000)
/lib64/ld-linux-x86-64.so.2 (0x00007b5ed46ae000)
```

We currently [test](.github/workflows/ci.yml) every commit and the released
`.so` generated with Java 8 against the following platforms and distributions:

Expand All @@ -285,7 +297,6 @@ Verified for Java 8, 11, 17, 21 against openjdk (temurin), zulu and corretto
Verified for Java 8 against openjdk

### Other Architectures

We do not test against ARM or Windows. `jvmquake` probably still works fine
if compiled on the same platform, but it is not tested.

![Build Status](https://github.com/Netflix-Skunkworks/jvmquake/actions/workflows/ci.yml/badge.svg)

0 comments on commit bd63a7f

Please sign in to comment.