forked from apache/zookeeper
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'apache/master' into ZOOKEEPER-3188
- Loading branch information
Showing
167 changed files
with
1,916 additions
and
1,383 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # README file for Packaging Notes | ||
|
|
||
| The ZooKeeper project publishes releases as tarballs. For ZooKeeper packages | ||
| specific to your OS (such as rpm and deb), consider using Apache Bigtop: | ||
|
|
||
| http://bigtop.apache.org/ | ||
|
|
||
|
|
||
| ## Requirements | ||
|
|
||
| - ant (recommended version 1.9.4 or later for concurrent JUnit test execution) or maven to build the java code | ||
| - gcc, cppunit and python-setuptools are required to build C and python bindings. | ||
|
|
||
| On RHEL machine: | ||
|
|
||
| ``` | ||
| yum install cppunit | ||
| yum install python-setuptools | ||
| ``` | ||
|
|
||
| On Ubuntu: | ||
|
|
||
| ``` | ||
| apt-get install cppunit | ||
| apt-get install python-setuptools | ||
| ``` | ||
|
|
||
|
|
||
| ## Package build command (using maven) | ||
|
|
||
| Commands to clean everything and build the tarball package without executing the tests: `mvn clean install -DskipTests` | ||
|
|
||
|
|
||
| `zookeeper-assembly/target/apache-zookeeper-<version>-bin.tar.gz` tarball file structure layout: | ||
|
|
||
| - `/bin` - User executables | ||
| - `/conf` - Configuration files | ||
| - `/lib` - ZooKeeper JAR files and all the required java library dependencies | ||
| - `/docs` - Documents | ||
|
|
||
| Beside the binary tarball, you can find the whole original source project packaged into: | ||
| `zookeeper-assembly/target/apache-zookeeper-<version>.tar.gz` | ||
|
|
||
|
|
||
| ### Building the C client (using maven) | ||
|
|
||
| To also build the C client, you need to activate the `full-build` profile: | ||
|
|
||
| ``` | ||
| mvn clean -Pfull-build | ||
| mvn install -Pfull-build -DskipTests | ||
| ``` | ||
|
|
||
| Optional parameters you might consider when using maven: | ||
| - `-Pfull-build` - activates the full-build profile, causing the C client to be built | ||
| - `-DskipTests` - this parameter will skip both java and C++ unit test execution during the build | ||
| - `-Pc-test-coverage` - activates the test coverage calculation during the execution of C client tests | ||
|
|
||
| Please note: if you don't provide the `-Pfull-build` parameter, then the C client will not be built, the C client tests | ||
| will not be executed and the previous C client builds will no be cleaned up (e.g. with simply using `mvn clean`). | ||
|
|
||
| The compiled C client can be found here: | ||
| - `zookeeper-client/zookeeper-client-c/target/c/bin` - User executable | ||
| - `zookeeper-client/zookeeper-client-c/target/c/lib` - Native libraries | ||
| - `zookeeper-client/zookeeper-client-c/target/c/include/zookeeper` - Native library headers | ||
|
|
||
| The same folders gets archived to the `zookeeper-assembly/target/apache-zookeeper-<version>-lib.tar.gz` file, assuming you activated the `full-build` maven profile. | ||
|
|
||
| ## Package build command (using ant) | ||
|
|
||
| **Command to build tarball package:** `ant tar` | ||
|
|
||
| `zookeeper-<version>.tar.gz` tarball file structure layout: | ||
|
|
||
| - `/bin` - User executable | ||
| - `/sbin` - System executable | ||
| - `/libexec` - Configuration boot trap script | ||
| - `/lib` - Library dependencies | ||
| - `/docs` - Documents | ||
| - `/share/zookeeper` - Project files | ||
|
|
||
|
|
||
| **Command to build tarball package with native components:** `ant package-native tar` | ||
|
|
||
| `zookeeper-<version>-lib.tar.gz` tarball file structure layout: | ||
|
|
||
| - `/bin` - User executable | ||
| - `/lib` - Native libraries | ||
| - `/include/zookeeper` - Native library headers | ||
|
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd"> | ||
| <!-- | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| --> | ||
| <id>lib-package</id> | ||
| <formats> | ||
| <format>tar.gz</format> | ||
| </formats> | ||
| <includeBaseDirectory>true</includeBaseDirectory> | ||
|
|
||
| <fileSets> | ||
| <fileSet> | ||
| <!-- ZooKeeper C client lib and include files --> | ||
| <directory>${project.basedir}/../zookeeper-client/zookeeper-client-c/target/c</directory> | ||
| <outputDirectory>usr</outputDirectory> | ||
| <includes> | ||
| <include>include/**/*</include> | ||
| <include>lib/*</include> | ||
| </includes> | ||
| <fileMode>${rw.file.permission}</fileMode> | ||
| <directoryMode>${rwx.file.permission}</directoryMode> | ||
| </fileSet> | ||
| <fileSet> | ||
| <!-- ZooKeeper C client binaries--> | ||
| <directory>${project.basedir}/../zookeeper-client/zookeeper-client-c/target/c</directory> | ||
| <outputDirectory>usr</outputDirectory> | ||
| <includes> | ||
| <include>bin/*</include> | ||
| </includes> | ||
| <fileMode>${rwx.file.permission}</fileMode> | ||
| <directoryMode>${rwx.file.permission}</directoryMode> | ||
| </fileSet> | ||
| <fileSet> | ||
| <!-- ZooKeeper license --> | ||
| <directory>${project.basedir}/..</directory> | ||
| <includes> | ||
| <include>LICENSE.txt</include> | ||
| </includes> | ||
| <fileMode>${rw.file.permission}</fileMode> | ||
| <directoryMode>${rwx.file.permission}</directoryMode> | ||
| </fileSet> | ||
|
|
||
| </fileSets> | ||
|
|
||
| </assembly> |
Oops, something went wrong.