Merge pull request Cyan4973#618 from Cyan4973/dev

v0.8.1

Author: Cyan4973

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ xxhsum_inlinedXXH
 dispatch
 tests/generate_unicode_test
 
-# compilation chain
+# local conf
 .clang_complete
 
 # Mac OS-X artefacts

.gitignore

@@ -2,30 +2,32 @@ language: c
 
 # Dump CPU info before start
 before_install:
-  - cat /proc/cpuinfo
+  - cat /proc/cpuinfo || echo /proc/cpuinfo is not present
 
 matrix:
   fast_finish: true
   include:
 
-    - name: General linux tests (Xenial)
-      dist: xenial
+    - name: General linux x64 tests
       arch: amd64
       addons:
         apt:
           packages:
-            - clang
             - g++-multilib
             - gcc-multilib
             - cppcheck
       script:
         - make -B test-all
         - make clean
-        - make dispatch
+        - CFLAGS="-Werror" MOREFLAGS="-Wno-sign-conversion" make dispatch  # removing sign conversion warnings due to a bug in gcc-5's definition of some AVX512 intrinsics
+        - make clean
+        - CFLAGS="-O1 -mavx512f -Werror" make
         - make clean
-        - CC=g++ CFLAGS="-O1 -mavx512f" make
+        - CFLAGS="-Wall -Wextra -Werror" make DISPATCH=1
         - make clean
-        - CC=g++ CFLAGS="-Wall -Wextra" make DISPATCH=1
+        - CFLAGS="-std=c90 -pedantic -Wno-long-long -Werror" make xxhsum  # check C90 + long long compliance
+        - make c90test # strict c90, with no long long support; resulting in no XXH64_* symbol
+        - make noxxh3test # check library can be compiled with XXH_NO_XXH3, resulting in no XXH3_* symbol
 
 
     - name: Check results consistency on x64
@@ -42,6 +44,14 @@ matrix:
         - CPPFLAGS=-DXXH_REROLL=1 make check   # reroll code path (#240)
         - make -C tests/bench
 
+    - name: macOS General Test
+      os: osx
+      compiler: clang
+      script:
+        - CFLAGS="-Werror" make   # test library build
+        - make clean
+        - make test MOREFLAGS='-Werror' | tee # test scenario where `stdout` is not the console
+
     - name: ARM compilation and consistency checks (Qemu)
       dist: xenial
       arch: amd64
@@ -111,7 +121,7 @@ matrix:
         - CPPFLAGS=-DXXH_VECTOR=XXH_VSX CFLAGS="-O3 -maltivec -mvsx -mpower8-vector -mcpu=power8" LDFLAGS="-static" make check
         # altivec.h redefinition issue #426
         - make clean
-        - CPPFLAGS=-DXXH_VECTOR=XXH_VSX CFLAGS="-maltivec -mvsx -mcpu=power8 -mpower8-vector" make -C tests test_ppc_redefine 
+        - CPPFLAGS=-DXXH_VECTOR=XXH_VSX CFLAGS="-maltivec -mvsx -mcpu=power8 -mpower8-vector" make -C tests test_ppc_redefine
 
     - name: IBM s390x compilation and consistency checks
       dist: bionic
@@ -129,4 +139,4 @@ matrix:
         - mkdir build
         - cd build
         - cmake ..
-        - make
+        - CFLAGS=-Werror make

.travis.yml

@@ -1,3 +1,22 @@
+v0.8.1
+- perf : much improved performance for XXH3 streaming variants, notably on gcc and msvc
+- perf : improved XXH64 speed and latency on small inputs
+- perf : small XXH32 speed and latency improvement on small inputs of random size
+- perf : minor stack usage improvement for XXH32 and XXH64
+- api  : new experimental variants XXH3_*_withSecretandSeed()
+- api  : update XXH3_generateSecret(), can no generate secret of any size (>= XXH3_SECRET_SIZE_MIN)
+- cli  : xxhsum can now generate and check XXH3 checksums, using command `-H3`
+- build: can build xxhash without XXH3, with new build macro XXH_NO_XXH3
+- build: fix xxh_x86dispatch build with MSVC, by @apankrat
+- build: XXH_INLINE_ALL can always be used safely, even after XXH_NAMESPACE or a previous XXH_INLINE_ALL
+- build: improved PPC64LE vector support, by @mpe
+- install: fix pkgconfig, by @ellert
+- install: compatibility with Haiku, by @Begasus
+- doc  : code comments made compatible with doxygen, by @easyaspi314
+- misc : XXH_ACCEPT_NULL_INPUT_POINTER is no longer necessary, all functions can accept NULL input pointers, as long as size == 0
+- misc : complete refactor of CI tests on Github Actions, offering much larger coverage, by @t-mat
+- misc : xxhsum code base split into multiple specialized units, within directory cli/, by @easyaspi314
+
 v0.8.0
 - api : stabilize XXH3
 - cli : xxhsum can parse BSD-style --check lines, by @WayneD

CHANGELOG

@@ -0,0 +1,58 @@
+# Doxygen config for xxHash
+DOXYFILE_ENCODING      = UTF-8
+
+PROJECT_NAME           = "xxHash"
+PROJECT_NUMBER         = "0.8.0"
+PROJECT_BRIEF          = "Extremely fast non-cryptographic hash function"
+OUTPUT_DIRECTORY       = doxygen
+OUTPUT_LANGUAGE        = English
+
+# We already separate the internal docs.
+INTERNAL_DOCS          = YES
+# Consistency
+SORT_MEMBER_DOCS       = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+
+# Warnings
+QUIET                  = YES
+# Until we document everything
+WARN_IF_UNDOCUMENTED   = NO
+
+# TODO: Add the other files. It is just xxhash.h for now.
+FILE_PATTERNS          = xxhash.h xxh_x86dispatch.c
+# Note: xxHash's source files are technically ASCII only.
+INPUT_ENCODING         = UTF-8
+TAB_SIZE               = 4
+MARKDOWN_SUPPORT       = YES
+
+# xxHash is a C library
+OPTIMIZE_OUTPUT_FOR_C  = YES
+# So we can document the internals
+EXTRACT_STATIC         = YES
+# Document the macros
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+# Predefine some macros to clean up the output.
+PREDEFINED             = "XXH_DOXYGEN=" \
+                         "XXH_PUBLIC_API=" \
+                         "XXH_FORCE_INLINE=static inline" \
+                         "XXH_NO_INLINE=static" \
+                         "XXH_RESTRICT=restrict" \
+                         "XSUM_API=" \
+                         "XXH_STATIC_LINKING_ONLY" \
+                         "XXH_IMPLEMENTATION" \
+                         "XXH_ALIGN(N)=alignas(N)" \
+                         "XXH_ALIGN_MEMBER(align,type)=alignas(align) type"
+
+# We want HTML docs
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+# Tweak the colors a bit
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_GAMMA  = 100
+HTML_COLORSTYLE_SAT    = 100
+
+# We don't want LaTeX.
+GENERATE_LATEX         = NO

Doxyfile

@@ -24,25 +24,3 @@ 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.
-
-----------------------------------------------------
-
-xxhsum command line interface
-Copyright (c) 2013-2020 Yann Collet
-All rights reserved.
-
-GPL v2 License
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.