You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2019/09/19 18:02:16 UTC
[incubator-datasketches-java] 01/01: Refactor License,
Notice and Readme
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch Licenses
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-java.git
commit fb6b80cc623115d8d146d0bae19151a0b729c864
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Thu Sep 19 10:59:52 2019 -0700
Refactor License, Notice and Readme
---
LICENSE | 88 +++++++++++++++++++++++++++++++++++++++------------------------
NOTICE | 36 --------------------------
README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++---
3 files changed, 116 insertions(+), 74 deletions(-)
diff --git a/LICENSE b/LICENSE
index 04db4e5..10e39dd 100644
--- a/LICENSE
+++ b/LICENSE
@@ -202,40 +202,60 @@ APPENDIX A: How to apply the Apache License to your work.
limitations under the License.
---------------------------------------------
-APPENDIX B: Additional licenses relevant to this work.
-
- Apache DataSketches-java (INCUBATING):
+APPENDIX B: Additional licenses relevant to Apache DataSketches-java (INCUBATING):
Apache DataSketches-java (incubating) includes a number of source
- files with separate copyright notices and license terms. Your use of
+ files with code that has been adapted from 3rd party source code
+ subject to different copyright notices and license terms. Your use of
the source code for these subcomponents is subject to the terms and
- conditions of the following licenses. See the NOTICE file for details
- of the licence dependencies that refer to the following licences.
-
-
-BSD-2-Clause License
-================================
-Copyright (C) 2012-2016, Yann Collet.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ conditions of the following licenses.
+
+ BSD-2-Clause License
+ ================================
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ Code locations subject to the above license:
+ -------------------------------------------------------------
+ This product contains code to implement the xxHash function:
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/XxHash.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/XxHashTest.java
+ and adapted from C++ source code located at:
+ * https://github.com/Cyan4973/xxHash/blob/dev/xxhash.c
+ * https://github.com/Cyan4973/xxHash/blob/dev/xxhash.h
+ Copyright (C) 2012-2016, Yann Collet.
+
+
+ Public Domain (optional)
+ ================================
+ This product contains code to implement and test Austin Appleby's C++ public domain implementation of the
+ MurmurHash3 algorithm,
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3Adaptor.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3v2.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3AdaptorTest.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3Test.java
+ * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3v2Test.java
+ and adapted from C++ source code located at
+ https://github.com/aappleby/smhasher/blob/master/src/MurmurHash3.cpp
+
diff --git a/NOTICE b/NOTICE
index 6f50a5e..c0de960 100644
--- a/NOTICE
+++ b/NOTICE
@@ -9,39 +9,3 @@ The Apache Software Foundation (http://www.apache.org/).
Prior to moving to ASF, the software for this project was developed at
Yahoo (now Verizon Media) (https://developer.yahoo.com).
-
-This product contains 3rd party code under the following licenses:
-
-Apache License version 2.0 (see LICENSE)
-================================
-This product contains code to implement the xxHash function:
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/XxHash.java
-
-and was adapted from
- https://github.com/OpenHFT/Zero-Allocation-Hashing,
- Copyright 2015 Higher Frequency Trading http://www.higherfrequencytrading.com
-
-
-BSD-2-Clause License (see LICENSE):
-================================
-This product contains code to implement the xxHash function:
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/XxHash.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/XxHashTest.java
-and adapted from C++
- https://github.com/Cyan4973/xxHash/blob/dev/xxhash.c,
- https://github.com/Cyan4973/xxHash/blob/dev/xxhash.h,
- both Copyright (C) 2012-2016, Yann Collet.
-
-
-Public Domain (optional notice)
-================================
- This product contains the code to implement and test Austin Appleby's C++ implementation of the
- MurmurHash3 algorithm, which is in the public domain,
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3Adaptor.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/main/java/org/apache/datasketches/hash/MurmurHash3v2.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3AdaptorTest.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3Test.java
- * https://github.com/apache/incubator-datasketches-java/blob/master/src/test/java/org/apache/datasketches/hash/MurmurHash3v2Test.java
- and adapted from C++
- https://github.com/aappleby/smhasher/blob/master/src/MurmurHash3.cpp
diff --git a/README.md b/README.md
index 85eb840..1a12e25 100644
--- a/README.md
+++ b/README.md
@@ -35,11 +35,69 @@ Please refer to our [website](https://datasketches.github.io) for more comprehen
Note that we have a parallel core component for C++ and Python implementations of the same sketch algorithms,
[incubator-datasketches-cpp](https://github.com/apache/incubator-datasketches-cpp).
+## Documentation and Feedback
+
+### [DataSketches Library Website](https://datasketches.github.io/)
+
+### [Java Core Overview](https://datasketches.github.io/docs/TheChallenge.html)
+
+### [Java Core Javadocs](https://datasketches.github.io/api/core/snapshot/apidocs/index.html)
+
+### [Forum](https://groups.google.com/forum/#!forum/sketches-user)
+
+## Downloading Latest Release
+__NOTE:__ This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory
+ must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements.
+
+This is required by the Oracle Java Specification in order to ensure location-independent
+ access to resources: [See Oracle Location-Independent Access to Resources](https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html)
+
+### [Zip File from Apache Archive](http://archive.apache.org/dist/incubator/datasketches/java/)
+
+### [Jar Files from Maven Central](https://repository.apache.org/content/repositories/releases/org/apache/datasketches/datasketches-java/)
+
+### [GitHub](https://github.com/apache/incubator-datasketches-java/releases)
+
+## Build Instructions
+
+### JDK8 is Required Compiler
+This DataSketches component is pure Java and you must compile using JDK 8.
+
+### Recommended Build Tool
+The DataSketches-java component structured as a Maven project and Maven is the recommended Build Tool.
+
+There are two types of tests: normal unit tests and tests run by the strict profile.
+
+To run normal unit tests:
+
+ $ mvn clean test
+
+To run the strict profile tests:
+
+ $ mvn clean test -P strict
+
+To install jars built from the downloaded source:
+
+ $ mvn clean install -DskipTests=true
+
+This will create the following jars:
+
+* datasketches-java-X.Y.Z-incubating.jar The compiled main class files.
+* datasketches-java-X.Y.Z-incubating-tests.jar The compiled test class files.
+* datasketches-java-X.Y.Z-incubating-sources.jar The main source files.
+* datasketches-java-X.Y.Z-incubating-test-sources.jar The test source files
+* datasketches-java-X.Y.Z-incubating-javadoc.jar The compressed Javadocs.
+
+### Dependencies
+
+#### Run-time
+There is one run-time dependency:
+
+* org.apache.datasketches : datasketches-memory
+
+#### Testing
+See the pom.xml file for test dependencies.
-## [DataSketches Library Website](https://datasketches.github.io/)
-## [Latest Release](https://github.com/apache/incubator-datasketches-java/releases)
-## [Forum](https://groups.google.com/forum/#!forum/sketches-user)
-## Note: This package can only be compiled using Java 1.8.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org