This is an automated email from the ASF dual-hosted git repository.
JackieTien97 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new ad0900813fe [Docs] Correct the stale thrift code generation pitfall in
AGENTS.md
ad0900813fe is described below
commit ad0900813fe0bce3c6ffedc2015ca61b2670b4ce
Author: CritasWang <[email protected]>
AuthorDate: Wed Nov 18 10:28:12 2026 +0800
[Docs] Correct the stale thrift code generation pitfall in AGENTS.md
---
AGENTS.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index 356785d276f..e93ae576647 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -211,9 +211,9 @@ Generated source directories that need to be on the source
path:
### Build
-- **Missing Thrift compiler**: The local machine may not have the `thrift`
binary installed. Running `mvn clean package -pl <module> -am -DskipTests` will
fail at the `iotdb-thrift` module. **Workaround**: To verify your changes
compile, use `mvn compile -pl <module>` (without `-am` or `clean`) to leverage
existing target caches.
+- **Thrift code generation needs no local `thrift` binary**: the root
`pom.xml` carries a self-activating `.thrift-generation` profile. It turns on
for any module containing `src/main/thrift`, unpacks
`org.apache.iotdb.tools:iotdb-tools-thrift` (version
`${iotdb-tools-thrift.version}` in the root pom, currently `0.25.0.0`) with the
classifier of the current OS (`mac-aarch64`, `mac-x86_64`, `linux-x86_64`,
`linux-aarch64`, `windows-x86_64`, `windows-aarch64`) into that module's
`target/th [...]
- **Pre-existing compilation errors in unrelated modules**: The datanode
module may have pre-existing compile errors in other subsystems (e.g., pipe,
copyto) that cause `mvn clean test -pl iotdb-core/datanode -Dtest=XxxTest` to
fail during compilation. **Workaround**: First run `mvn compile -pl
iotdb-core/datanode` to confirm your changed files compile successfully. If the
errors are in files you did not modify, they are pre-existing and do not affect
your changes.
-- **Single-module / no-`clean` compiles hide cross-module and i18n errors**:
`mvn compile -pl <module>` (the thrift workaround above) builds only that
module against the **installed** jars in `~/.m2` and the existing `target/`
classes; an incremental `mvn test-compile` without `clean` reuses stale
`target/*.class`. If you add/rename a `*Messages` constant (or any cross-module
API) in module B but `~/.m2`/`target/` still holds B's old artifact, module A
referencing the new symbol compiles [...]
+- **Single-module / no-`clean` compiles hide cross-module and i18n errors**:
`mvn compile -pl <module>` (no `-am`) builds only that module against the
**installed** jars in `~/.m2` and the existing `target/` classes; an
incremental `mvn test-compile` without `clean` reuses stale `target/*.class`.
If you add/rename a `*Messages` constant (or any cross-module API) in module B
but `~/.m2`/`target/` still holds B's old artifact, module A referencing the
new symbol compiles fine against the s [...]
### i18n (Chinese Messages)