From bd63a7f5ced903d3a55333948ce5b8a8fc8466aa Mon Sep 17 00:00:00 2001 From: Joseph Lynch Date: Tue, 16 Apr 2024 14:36:41 -0700 Subject: [PATCH] Update readme --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c3b3055..b816ad7 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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` @@ -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: @@ -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)