Skip to content

Commit 4a21592

Browse files
authored
Merge pull request #6909 from halibobo1205/codex/docs-jdk-architecture
docs: clarify architecture-specific JDK requirements
2 parents f87081b + 378f89e commit 4a21592

3 files changed

Lines changed: 40 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,16 @@ TRON is building the foundational infrastructure for the decentralized internet
3737
Before building java-tron, make sure you have:
3838
- Hardware with at least 4 CPU cores, 16 GB RAM, 10 GB free disk space for a smooth compilation process.
3939
- Operating system: `Linux` or `macOS` (`Windows` is not supported).
40-
- Git and correct JDK (version `8` or `17`) installed based on your CPU architecture.
40+
- Git and the JDK matching your CPU architecture (see the table below).
41+
42+
The JDK version required to build or run java-tron is currently tied to the CPU architecture; the two versions are not interchangeable:
43+
44+
| CPU Architecture | Required JDK |
45+
| :--------------- | :----------- |
46+
| `x86_64` / `amd64` | JDK 8 |
47+
| `ARM64` / `aarch64` | JDK 17 |
48+
49+
> **Note**: `ARM64` / `aarch64` support is available starting with GreatVoyage-v4.8.1.
4150
4251
There are two ways to install the required dependencies:
4352

@@ -49,8 +58,6 @@ There are two ways to install the required dependencies:
4958
chmod +x install_dependencies.sh
5059
./install_dependencies.sh
5160
```
52-
> **Note**: For production-grade stability with JDK 8 on x86_64 architecture, Oracle JDK 8 is strongly recommended (the script installs OpenJDK 8).
53-
5461
- **Option 2: Manual installation**
5562

5663
Follow the [Prerequisites and Installation Guide](https://tronprotocol.github.io/documentation-en/using_javatron/installing_javatron/#prerequisites-before-compiling-java-tron) for step-by-step instructions.

‎docs/modular-deployment-en.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ After modularization, the recommended way to launch java-tron is via the shell s
44

55
> **Supported platforms**: Linux and macOS. Windows is not supported.
66
7+
## Prerequisites
8+
9+
The JDK version required to build and run java-tron is currently tied to the CPU architecture; the two versions are not interchangeable:
10+
11+
| CPU Architecture | Required JDK |
12+
| :--------------- | :----------- |
13+
| `x86_64` / `amd64` | JDK 8 |
14+
| `ARM64` / `aarch64` | JDK 17 |
15+
16+
> **Note**: `ARM64` / `aarch64` support is available starting with GreatVoyage-v4.8.1.
17+
718
## Download
819

920
```
@@ -45,11 +56,9 @@ java-tron-1.0.0/bin/FullNode -c config.conf -w
4556

4657
JVM options can also be specified, located in `bin/java-tron.vmoptions`:
4758
```
48-
# demo (compatible with JDK 8 / JDK 17)
59+
# Heap-size customization example
4960
-Xms2g
5061
-Xmx9g
51-
-XX:+PrintGCDetails
52-
-Xloggc:./gc.log
53-
-XX:+PrintGCDateStamps
54-
-XX:ReservedCodeCacheSize=256m
55-
```
62+
```
63+
64+
The generated `java-tron.vmoptions` file already contains GC options appropriate for the build architecture and its required JDK. Keep those architecture-specific options when changing the heap size; do not copy GC options between JDK 8 and JDK 17 deployments.

‎docs/modular-deployment-zh.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44

55
> **支持平台**:Linux 和 macOS。不支持 Windows。
66
7+
## 环境要求
8+
9+
当前,构建和运行 java-tron 所需的 JDK 版本与 CPU 架构绑定,两个版本不能互换:
10+
11+
| CPU 架构 | 所需 JDK |
12+
| :------- | :------- |
13+
| `x86_64` / `amd64` | JDK 8 |
14+
| `ARM64` / `aarch64` | JDK 17 |
15+
16+
> **注意**:从 GreatVoyage-v4.8.1 开始支持 `ARM64` / `aarch64` 架构。
17+
718
## 下载
819

920
```
@@ -43,11 +54,9 @@ java-tron-1.0.0/bin/FullNode -c config.conf -w
4354

4455
java-tron 支持对 jvm 参数进行配置,配置文件为 bin 目录下的 java-tron.vmoptions 文件。
4556
```
46-
# demo(兼容 JDK 8 / JDK 17)
57+
# 堆大小自定义示例
4758
-Xms2g
4859
-Xmx9g
49-
-XX:+PrintGCDetails
50-
-Xloggc:./gc.log
51-
-XX:+PrintGCDateStamps
52-
-XX:ReservedCodeCacheSize=256m
53-
```
60+
```
61+
62+
生成的 `java-tron.vmoptions` 文件已包含与构建架构及其所需 JDK 匹配的 GC 参数。调整堆大小时请保留这些架构专用参数,不要在 JDK 8 和 JDK 17 部署之间复制 GC 参数。

0 commit comments

Comments
 (0)