Merge pull request #873 from Cyan4973/dev

v0.8.2

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.gitignore

@@ -18,6 +18,8 @@ xxhsum_privateXXH
 xxhsum_inlinedXXH
 dispatch
 tests/generate_unicode_test
+tests/sanity_test
+tests/sanity_test_vectors_generator
 
 # local conf
 .clang_complete
@@ -45,3 +47,6 @@ infer-out
 tmp*
 tests/*.unicode
 tests/unicode_test*
+
+# Doxygen
+doxygen/

CHANGELOG

@@ -1,3 +1,27 @@
+v0.8.2
+- fix  : XXH3 S390x vector implementation (@hzhuang1)
+- fix  : PowerPC vector compilation with IBM XL compiler (@MaxiBoether)
+- perf : improved WASM speed by x2/x3 using SIMD128 (@easyaspi314)
+- perf : improved speed (+20%) for XXH3 on ARM NEON (@easyaspi314)
+- cli  : Fix filename contain /LF character (@t-mat)
+- cli  : Support # comment lines in --check files (@t-mat)
+- cli  : Support commands --binary and --ignore-missing (@t-mat)
+- build: fix -Og compilation (@easyaspi314, @t-mat)
+- build: fix pkgconfig generation with cmake (@ilya-fedin)
+- build: fix icc compilation
+- build: fix cmake install directories
+- build: new build options XXH_NO_XXH3, XXH_SIZE_OPT and XXH_NO_STREAM to reduce binary size (@easyaspi314)
+- build: dedicated install targets (@ffontaine)
+- build: support DISPATCH mode in cmake (@hzhuang1)
+- portability: fix x86dispatch when building with Visual + clang-cl (@t-mat)
+- portability: SVE vector implementation of XXH3 (@hzhuang1)
+- portability: compatibility with freestanding environments, using XXH_NO_STDLIB
+- portability: can build on Haiku (@Begasus)
+- portability: validated on m68k and risc-v
+- doc  : XXH3 specification (@Adrien1018)
+- doc  : improved doxygen documentation (@easyaspi314, @t-mat)
+- misc : dedicated sanity test binary (@t-mat)
+
 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

Doxyfile

@@ -2,13 +2,13 @@
 DOXYFILE_ENCODING      = UTF-8
 
 PROJECT_NAME           = "xxHash"
-PROJECT_NUMBER         = "0.8.0"
+PROJECT_NUMBER         = "0.8.2"
 PROJECT_BRIEF          = "Extremely fast non-cryptographic hash function"
 OUTPUT_DIRECTORY       = doxygen
 OUTPUT_LANGUAGE        = English
 
 # We already separate the internal docs.
-INTERNAL_DOCS          = YES
+INTERNAL_DOCS          = NO
 # Consistency
 SORT_MEMBER_DOCS       = NO
 BRIEF_MEMBER_DESC      = YES
@@ -28,8 +28,10 @@ MARKDOWN_SUPPORT       = YES
 
 # xxHash is a C library
 OPTIMIZE_OUTPUT_FOR_C  = YES
-# So we can document the internals
-EXTRACT_STATIC         = YES
+# We hide private part from public document
+EXTRACT_STATIC         = NO
+# We hide private part from public document
+EXTRACT_PRIVATE        = NO
 # Document the macros
 MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
@@ -42,6 +44,9 @@ PREDEFINED             = "XXH_DOXYGEN=" \
                          "XSUM_API=" \
                          "XXH_STATIC_LINKING_ONLY" \
                          "XXH_IMPLEMENTATION" \
+                         "XXH_PUREF=[[gnu::pure]]" \
+                         "XXH_CONSTF=[[gnu::const]]" \
+                         "XXH_MALLOCF=[[gnu::malloc]]" \
                          "XXH_ALIGN(N)=alignas(N)" \
                          "XXH_ALIGN_MEMBER(align,type)=alignas(align) type"
 

Doxyfile-internal

@@ -0,0 +1,63 @@
+# Doxygen config for xxHash
+DOXYFILE_ENCODING      = UTF-8
+
+PROJECT_NAME           = "xxHash"
+PROJECT_NUMBER         = "0.8.2"
+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
+# We show private part in the internal document
+EXTRACT_PRIVATE        = 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_PUREF=[[gnu::pure]]" \
+                         "XXH_CONSTF=[[gnu::const]]" \
+                         "XXH_MALLOCF=[[gnu::malloc]]" \
+                         "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

LICENSE

@@ -1,5 +1,5 @@
 xxHash Library
-Copyright (c) 2012-2020 Yann Collet
+Copyright (c) 2012-2021 Yann Collet
 All rights reserved.
 
 BSD 2-Clause License (https://www.opensource.org/licenses/bsd-license.php)