You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: correct AGENTS.md platform and build details
- Note the build fails fast on a JDK/arch mismatch
- Scope the lint helper comment to framework main
- Fix the generated-protobuf source path (core/, api/ subdirs)
- Add the platform module (arch-specific source sets) to the layout
- List both plugins jars (Toolkit, ArchiveManifest)
Copy file name to clipboardExpand all lines: AGENTS.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Guidance for AI coding assistants and new contributors working on java-tron: how
9
9
10
10
## Build & Test
11
11
12
-
Supported platforms: **Linux** and **macOS** only. JDK requirement: **JDK 8** on x86_64, **JDK 17** on ARM64/aarch64 (e.g. Apple Silicon Macs, or Linux aarch64 servers such as AWS Graviton).
12
+
Supported platforms: **Linux** and **macOS** only. JDK requirement is by CPU architecture: **JDK 8** on x86_64, **JDK 17** on ARM64/aarch64 (e.g. Apple Silicon Macs, or Linux aarch64 servers such as AWS Graviton). The build fails fast if the JDK major version does not match the architecture.
13
13
14
14
```bash
15
15
./gradlew clean build -x test# build without tests
@@ -19,15 +19,15 @@ Supported platforms: **Linux** and **macOS** only. JDK requirement: **JDK 8** on
19
19
./gradlew test --tests "org.tron.core.db.TronDatabaseTest"# one class
20
20
./gradlew test --tests "org.tron.core.db.TronDatabaseTest.testX"# one method
./gradlew checkstyleMain checkstyleTest # Checkstyle main + test (as CI runs)
24
24
./gradlew jacocoTestReport # coverage report
25
25
```
26
26
27
27
- Main entry point: `org.tron.program.FullNode`.
28
28
- Tests run in parallel locally, serially in CI (detected via the `CI` env var); the test-retry plugin retries up to 5 times.
29
29
- On ARM64/aarch64, only the RocksDB storage engine is supported; the build forces RocksDB and skips the LevelDB tests.
30
-
- Protobuf / gRPC Java stubs are generated at build time from `protocol/src/main/protos/*.proto` (via the `com.google.protobuf` Gradle plugin) and are git-ignored — rebuild after changing a `.proto`; never hand-edit or commit generated sources.
30
+
- Protobuf / gRPC Java stubs are generated at build time from the `.proto` files under `protocol/src/main/protos/` (subdirectories `core/`, `api/`; via the `com.google.protobuf` Gradle plugin) and are git-ignored — rebuild after changing a `.proto`; never hand-edit or commit generated sources.
31
31
32
32
**Before pushing:**
33
33
-`./gradlew checkstyleMain checkstyleTest` and `./gradlew test` must pass.
@@ -44,7 +44,8 @@ Supported platforms: **Linux** and **macOS** only. JDK requirement: **JDK 8** on
44
44
|`actuator`| Transaction execution; one Actuator class per transaction type |
45
45
|`crypto`| Cryptographic primitives (depends only on `common`) |
0 commit comments