Skip to content

Commit 30cc497

Browse files
dfa1claude
andcommitted
refactor: rename coordinates — parent + zstd-java library
- root aggregator artifactId: zstd-java -> parent - library module: core/ -> zstd/, artifactId zstd-java-core -> zstd-java (the official coordinate: io.github.dfa1:zstd-java) - native/bom artifacts keep the zstd-java-* prefix - relocate the vendored submodule zstd/ -> third_party/zstd to free the zstd/ dir for the module; update .gitmodules and build-zstd.sh accordingly - refresh README/CLAUDE paths 40 tests green, checkstyle clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent d0a0b8b commit 30cc497

28 files changed

Lines changed: 23 additions & 22 deletions

File tree

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "zstd"]
2-
path = zstd
2+
path = third_party/zstd
33
url = https://github.com/facebook/zstd.git

CLAUDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ already off-heap (e.g. an mmap slice in, an arena buffer out).
1111

1212
Multi-module Maven build (`io.github.dfa1:zstd-java`):
1313

14-
- `core/`pure-Java FFM bindings (package `io.github.dfa1.zstdffm`). The only
15-
module with Java sources.
14+
- `zstd/`the library module, artifactId `zstd-java`, pure-Java FFM bindings
15+
(package `io.github.dfa1.zstdffm`). The only module with Java sources.
1616
- `native/<classifier>/` — one module per platform; each packages a
17-
`libzstd.{dylib,so,dll}` built from the `zstd/` submodule. No Java.
17+
`libzstd.{dylib,so,dll}` built from the `third_party/zstd` submodule. No Java.
1818
Classifiers: `osx-aarch64`, `osx-x86_64`, `linux-x86_64`, `linux-aarch64`,
1919
`windows-x86_64`, `windows-aarch64`.
2020
- `bom/` — dependency BOM.
21-
- `zstd/` — vendored `facebook/zstd` git submodule (the C source of truth).
21+
- `third_party/zstd/` — vendored `facebook/zstd` git submodule (the C source of truth).
2222

2323
## Native build
2424

@@ -81,4 +81,4 @@ Built `.dylib/.so/.dll` are git-ignored; they are regenerated from the submodule
8181
`<strong>`,`<pre>`,`<table>`, …). Use blank `///` for paragraphs, `- ` lists, ` ```java ``` `,
8282
`**bold**`. Cross-refs `[ClassName#method(ParamType)]` — verify the target exists (wrong refs are
8383
**errors**).
84-
- Check: `./mvnw javadoc:javadoc -pl core` must produce zero output.
84+
- Check: `./mvnw javadoc:javadoc -pl zstd` must produce zero output.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ libc for every target, enabling hermetic cross-compilation without a sysroot.
2222

2323
## Supported platforms
2424

25-
The library ships as pure-Java `core` plus one native artifact per platform:
25+
The library — `io.github.dfa1:zstd-java` — ships as a pure-Java module plus one
26+
native artifact per platform:
2627

2728
| OS | aarch64 | x86_64 |
2829
|---------|:-------:|:------:|
@@ -118,7 +119,7 @@ mvn test
118119
```
119120

120121
The `mvn` build invokes `scripts/build-zstd.sh`, which compiles
121-
`libzstd.{dylib,so,dll}` from the `zstd/` submodule with `zig cc`. The script
122+
`libzstd.{dylib,so,dll}` from the `third_party/zstd` submodule with `zig cc`. The script
122123
cross-compiles any of the six targets from any host:
123124

124125
```bash

bom/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../pom.xml</relativePath>
1010
</parent>
@@ -17,7 +17,7 @@
1717
<dependencies>
1818
<dependency>
1919
<groupId>io.github.dfa1</groupId>
20-
<artifactId>zstd-java-core</artifactId>
20+
<artifactId>zstd-java</artifactId>
2121
<version>${project.version}</version>
2222
</dependency>
2323
<dependency>

native/linux-aarch64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

native/linux-x86_64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

native/osx-aarch64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

native/osx-x86_64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

native/windows-aarch64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

native/windows-x86_64/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<parent>
66
<groupId>io.github.dfa1</groupId>
7-
<artifactId>zstd-java</artifactId>
7+
<artifactId>parent</artifactId>
88
<version>0.1-SNAPSHOT</version>
99
<relativePath>../../pom.xml</relativePath>
1010
</parent>

0 commit comments

Comments
 (0)