From 9dda713e70b93200acea370067304b9f5188f295 Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Tue, 14 Feb 2023 11:38:00 +0800 Subject: [PATCH] update docs about arthas-vmtool --- CONTRIBUTING.md | 4 ++++ arthas-vmtool/README.md | 2 ++ 2 files changed, 6 insertions(+) create mode 100644 arthas-vmtool/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 737a33a61..2b563becb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,8 @@ Please refer to [README.MD at tutorials/katacoda](tutorials/katacoda/README.md#c * If you encounter jfr related problems, it is recommended to use `8u262` and later versions of openjdk8 or zulu jdk8, https://mail.openjdk.org/pipermail/jdk8u-dev/2020-July/012143.html ### Local Installation +> Note: After modifying `arthas-vmtool` related codes, the packaging results need to be manually copied to the `lib/` path of this repo, and will not be copied automatically. + Recommend to use [`as-package.sh`](as-package.sh) to package, which will auto-install the latest Arthas to local `~/.arthas` and when debugging, Arthas will auto-load the latest version. * To support jni, cpp compiling environment support is required @@ -86,6 +88,8 @@ Tip: you can use `--versions` to list all available versions. * 如果遇到jfr相关问题，建议使用`8u262`及之后的高版本 openjdk8 或者zulu jdk8， https://mail.openjdk.org/pipermail/jdk8u-dev/2020-July/012143.html ### 安装到本地 +> 注意： 修改`arthas-vmtool`相关代码后，打包结果需要手动复制到本仓库的 `lib/` 路径下，不会自动复制。 + 本地开发时，推荐执行`as-package.sh`来打包，会自动安装最新版本的arthas到`~/.arthas`目录里。debug时会自动使用最新版本。 * 代码里要编译jni，需要cpp编译环境支持 diff --git a/arthas-vmtool/README.md b/arthas-vmtool/README.md new file mode 100644 index 000000000..0052775fa --- /dev/null +++ b/arthas-vmtool/README.md @@ -0,0 +1,2 @@ + +注意： 修改`arthas-vmtool`相关代码后，打包结果需要手动复制到本仓库的 `lib/` 路径下，不会自动复制。 \ No newline at end of file