Skip to content

Commit 18250df

Browse files
author
Mate Szalay-Beko
committed
ZOOKEEPER-3436 remove the C binaries from the binary tarball; update the readme files
1 parent 57b7cd6 commit 18250df

3 files changed

Lines changed: 22 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ found in zookeeper-assembly/target directory after building the project with mav
2828

2929
Contains all the jar files required to run ZooKeeper
3030
Full documentation can also be found in the docs folder
31-
The compiled C-client is located in the /usr folder (if the build profile `-Pfull-build` used during maven install)
3231

3332
As of version 3.5.5, the parent, zookeeper and zookeeper-jute artifacts
3433
are deployed to the central repository after the release

‎README_packaging.md‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,31 +28,41 @@ apt-get install python-setuptools
2828

2929
## Package build command (using maven)
3030

31-
Commands to clean everything and build the tarball package without executing the tests:
31+
Commands to clean everything and build the tarball package without executing the tests: `mvn clean install -DskipTests`
32+
33+
34+
`zookeeper-assembly/target/apache-zookeeper-<version>-bin.tar.gz` tarball file structure layout:
35+
36+
- `/bin` - User executables
37+
- `/conf` - Configuration files
38+
- `/lib` - ZooKeeper JAR files and all the required java library dependencies
39+
- `/docs` - Documents
40+
41+
Beside the binary tarball, you can find the whole original source project packaged into:
42+
`zookeeper-assembly/target/apache-zookeeper-<version>.tar.gz`
43+
44+
45+
### Building the C client (using maven)
46+
47+
To also build the C client, you need to activate the `full-build` profile:
3248

3349
```
3450
mvn clean -Pfull-build
3551
mvn install -Pfull-build -DskipTests
3652
```
3753

3854
Optional parameters you might consider when using maven:
55+
- `-Pfull-build` - activates the full-build profile, causing the C client to be built
3956
- `-DskipTests` - this parameter will skip both java and C++ unit test execution during the build
40-
- `-Pfull-build` - activates the full-build profile, causing the C client and python code to be built
4157
- `-Pc-test-coverage` - activates the test coverage calculation during the execution of C client tests
4258

4359
Please note: if you don't provide the `-Pfull-build` parameter, then the C client will not be built, the C client tests
4460
will not be executed and the previous C client builds will no be cleaned up (e.g. with simply using `mvn clean`).
4561

46-
`zookeeper-assembly/target/apache-zookeeper-<version>-bin.tar.gz` tarball file structure layout:
47-
48-
- `/bin` - User executables
49-
- `/conf` - Configuration files
50-
- `/lib` - ZooKeeper JAR files and all the required java library dependencies
51-
- `/docs` - Documents
52-
- `/usr` - Native artifacts (only present if `-Pfull-build` used)
53-
54-
Beside the binary tarball, you can find the whole original source project packaged into:
55-
`zookeeper-assembly/target/apache-zookeeper-<version>.tar.gz`
62+
The compiled C client can be found here:
63+
- `zookeeper-client/zookeeper-client-c/target/c/bin` - User executable
64+
- `zookeeper-client/zookeeper-client-c/target/c/lib` - Native libraries
65+
- `zookeeper-client/zookeeper-client-c/target/c/include/zookeeper` - Native library headers
5666

5767

5868
## Package build command (using ant)

‎zookeeper-assembly/src/main/assembly/bin-package.xml‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -70,27 +70,6 @@
7070
<fileMode>${rw.file.permission}</fileMode>
7171
<directoryMode>${rwx.file.permission}</directoryMode>
7272
</fileSet>
73-
<fileSet>
74-
<!-- ZooKeeper C client, non-executables -->
75-
<directory>${project.basedir}/../zookeeper-client/zookeeper-client-c/target/c</directory>
76-
<outputDirectory>usr</outputDirectory>
77-
<includes>
78-
<include>include/**/*</include>
79-
<include>lib/*</include>
80-
</includes>
81-
<fileMode>${rw.file.permission}</fileMode>
82-
<directoryMode>${rwx.file.permission}</directoryMode>
83-
</fileSet>
84-
<fileSet>
85-
<!-- ZooKeeper C client, executables -->
86-
<directory>${project.basedir}/../zookeeper-client/zookeeper-client-c/target/c</directory>
87-
<outputDirectory>usr</outputDirectory>
88-
<includes>
89-
<include>bin/*</include>
90-
</includes>
91-
<fileMode>${rwx.file.permission}</fileMode>
92-
<directoryMode>${rwx.file.permission}</directoryMode>
93-
</fileSet>
9473
<fileSet>
9574
<!-- License files for 3rd party libs -->
9675
<directory>${project.basedir}/../zookeeper-server/src/main/resources/lib</directory>

0 commit comments

Comments
 (0)