zstd-ruby 1.5.1.0 → 1.5.2.1

data/ext/zstdruby/libzstd/Makefile

@@ -1,357 +0,0 @@
-# ################################################################
-# Copyright (c) Yann Collet, Facebook, Inc.
-# All rights reserved.
-#
-# This source code is licensed under both the BSD-style license (found in the
-# LICENSE file in the root directory of this source tree) and the GPLv2 (found
-# in the COPYING file in the root directory of this source tree).
-# You may select, at your option, one of the above-listed licenses.
-# ################################################################
-
-# Modules
-ZSTD_LIB_COMPRESSION ?= 1
-ZSTD_LIB_DECOMPRESSION ?= 1
-ZSTD_LIB_DICTBUILDER ?= 1
-ZSTD_LIB_DEPRECATED ?= 0
-
-# Input variables for libzstd.mk
-ifeq ($(ZSTD_LIB_COMPRESSION), 0)
-  ZSTD_LIB_DICTBUILDER = 0
-  ZSTD_LIB_DEPRECATED = 0
-endif
-
-ifeq ($(ZSTD_LIB_DECOMPRESSION), 0)
-  ZSTD_LEGACY_SUPPORT = 0
-  ZSTD_LIB_DEPRECATED = 0
-endif
-
-include libzstd.mk
-
-ZSTD_FILES := $(ZSTD_COMMON_FILES) $(ZSTD_LEGACY_FILES)
-
-ifneq ($(ZSTD_LIB_COMPRESSION), 0)
-  ZSTD_FILES += $(ZSTD_COMPRESS_FILES)
-endif
-
-ifneq ($(ZSTD_LIB_DECOMPRESSION), 0)
-  ZSTD_FILES += $(ZSTD_DECOMPRESS_FILES)
-endif
-
-ifneq ($(ZSTD_LIB_DEPRECATED), 0)
-  ZSTD_FILES += $(ZSTD_DEPRECATED_FILES)
-endif
-
-ifneq ($(ZSTD_LIB_DICTBUILDER), 0)
-  ZSTD_FILES += $(ZSTD_DICTBUILDER_FILES)
-endif
-
-ZSTD_LOCAL_SRC := $(notdir $(ZSTD_FILES))
-ZSTD_LOCAL_OBJ0 := $(ZSTD_LOCAL_SRC:.c=.o)
-ZSTD_LOCAL_OBJ := $(ZSTD_LOCAL_OBJ0:.S=.o)
-
-VERSION := $(ZSTD_VERSION)
-
-# Note: by default, the static library is built single-threaded and dynamic library is built
-# multi-threaded. It is possible to force multi or single threaded builds by appending
-# -mt or -nomt to the build target (like lib-mt for multi-threaded, lib-nomt for single-threaded).
-.PHONY: default
-default: lib-release
-
-CPPFLAGS_DYNLIB  += -DZSTD_MULTITHREAD # dynamic library build defaults to multi-threaded
-LDFLAGS_DYNLIB   += -pthread
-CPPFLAGS_STATLIB +=                    # static library build defaults to single-threaded
-
-
-ifeq ($(findstring GCC,$(CCVER)),GCC)
-decompress/zstd_decompress_block.o : CFLAGS+=-fno-tree-vectorize
-endif
-
-
-# macOS linker doesn't support -soname, and use different extension
-# see : https://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/DynamicLibraries/100-Articles/DynamicLibraryDesignGuidelines.html
-ifeq ($(UNAME), Darwin)
-  SHARED_EXT = dylib
-  SHARED_EXT_MAJOR = $(LIBVER_MAJOR).$(SHARED_EXT)
-  SHARED_EXT_VER = $(LIBVER).$(SHARED_EXT)
-  SONAME_FLAGS = -install_name $(LIBDIR)/libzstd.$(SHARED_EXT_MAJOR) -compatibility_version $(LIBVER_MAJOR) -current_version $(LIBVER)
-else
-  ifeq ($(UNAME), AIX)
-    SONAME_FLAGS =
-  else
-    SONAME_FLAGS = -Wl,-soname=libzstd.$(SHARED_EXT).$(LIBVER_MAJOR)
-  endif
-  SHARED_EXT = so
-  SHARED_EXT_MAJOR = $(SHARED_EXT).$(LIBVER_MAJOR)
-  SHARED_EXT_VER = $(SHARED_EXT).$(LIBVER)
-endif
-
-
-.PHONY: all
-all: lib
-
-
-.PHONY: libzstd.a  # must be run every time
-libzstd.a: CPPFLAGS += $(CPPFLAGS_STATLIB)
-
-SET_CACHE_DIRECTORY = \
-   +$(MAKE) --no-print-directory $@ \
-    BUILD_DIR=obj/$(HASH_DIR) \
-    CPPFLAGS="$(CPPFLAGS)" \
-    CFLAGS="$(CFLAGS)" \
-    LDFLAGS="$(LDFLAGS)"
-
-ifndef BUILD_DIR
-# determine BUILD_DIR from compilation flags
-
-libzstd.a:
-	$(SET_CACHE_DIRECTORY)
-
-else
-# BUILD_DIR is defined
-
-ZSTD_STATLIB_DIR := $(BUILD_DIR)/static
-ZSTD_STATLIB := $(ZSTD_STATLIB_DIR)/libzstd.a
-ZSTD_STATLIB_OBJ := $(addprefix $(ZSTD_STATLIB_DIR)/,$(ZSTD_LOCAL_OBJ))
-$(ZSTD_STATLIB): ARFLAGS = rcs
-$(ZSTD_STATLIB): | $(ZSTD_STATLIB_DIR)
-$(ZSTD_STATLIB): $(ZSTD_STATLIB_OBJ)
-  # Check for multithread flag at target execution time
-	$(if $(filter -DZSTD_MULTITHREAD,$(CPPFLAGS)),\
-    @echo compiling multi-threaded static library $(LIBVER),\
-    @echo compiling single-threaded static library $(LIBVER))
-	$(AR) $(ARFLAGS) $@ $^
-
-libzstd.a: $(ZSTD_STATLIB)
-	cp -f $< $@
-
-endif
-
-ifneq (,$(filter Windows%,$(TARGET_SYSTEM)))
-
-LIBZSTD = dll/libzstd.dll
-$(LIBZSTD): $(ZSTD_FILES)
-	@echo compiling dynamic library $(LIBVER)
-	$(CC) $(FLAGS) -DZSTD_DLL_EXPORT=1 -Wl,--out-implib,dll/libzstd.dll.a -shared $^ -o $@
-
-else  # not Windows
-
-LIBZSTD = libzstd.$(SHARED_EXT_VER)
-.PHONY: $(LIBZSTD)  # must be run every time
-$(LIBZSTD): CPPFLAGS += $(CPPFLAGS_DYNLIB)
-$(LIBZSTD): CFLAGS   += -fPIC -fvisibility=hidden
-$(LIBZSTD): LDFLAGS  += -shared $(LDFLAGS_DYNLIB)
-
-ifndef BUILD_DIR
-# determine BUILD_DIR from compilation flags
-
-$(LIBZSTD):
-	$(SET_CACHE_DIRECTORY)
-
-else
-# BUILD_DIR is defined
-
-ZSTD_DYNLIB_DIR := $(BUILD_DIR)/dynamic
-ZSTD_DYNLIB := $(ZSTD_DYNLIB_DIR)/$(LIBZSTD)
-ZSTD_DYNLIB_OBJ := $(addprefix $(ZSTD_DYNLIB_DIR)/,$(ZSTD_LOCAL_OBJ))
-
-$(ZSTD_DYNLIB): | $(ZSTD_DYNLIB_DIR)
-$(ZSTD_DYNLIB): $(ZSTD_DYNLIB_OBJ)
-# Check for multithread flag at target execution time
-	$(if $(filter -DZSTD_MULTITHREAD,$(CPPFLAGS)),\
-    @echo compiling multi-threaded dynamic library $(LIBVER),\
-    @echo compiling single-threaded dynamic library $(LIBVER))
-	$(CC) $(FLAGS) $^ $(LDFLAGS) $(SONAME_FLAGS) -o $@
-	@echo creating versioned links
-	ln -sf $@ libzstd.$(SHARED_EXT_MAJOR)
-	ln -sf $@ libzstd.$(SHARED_EXT)
-
-$(LIBZSTD): $(ZSTD_DYNLIB)
-	cp -f $< $@
-
-endif  # ifndef BUILD_DIR
-endif  # if windows
-
-.PHONY: libzstd
-libzstd : $(LIBZSTD)
-
-.PHONY: lib
-lib : libzstd.a libzstd
-
-
-# note : do not define lib-mt or lib-release as .PHONY
-# make does not consider implicit pattern rule for .PHONY target
-
-%-mt : CPPFLAGS_DYNLIB  := -DZSTD_MULTITHREAD
-%-mt : CPPFLAGS_STATLIB := -DZSTD_MULTITHREAD
-%-mt : LDFLAGS_DYNLIB   := -pthread
-%-mt : %
-	@echo multi-threaded build completed
-
-%-nomt : CPPFLAGS_DYNLIB  :=
-%-nomt : LDFLAGS_DYNLIB   :=
-%-nomt : CPPFLAGS_STATLIB :=
-%-nomt : %
-	@echo single-threaded build completed
-
-%-release : DEBUGFLAGS :=
-%-release : %
-	@echo release build completed
-
-
-# Generate .h dependencies automatically
-
-DEPFLAGS = -MT $@ -MMD -MP -MF
-
-$(ZSTD_DYNLIB_DIR)/%.o : %.c $(ZSTD_DYNLIB_DIR)/%.d | $(ZSTD_DYNLIB_DIR)
-	@echo CC $@
-	$(COMPILE.c) $(DEPFLAGS) $(ZSTD_DYNLIB_DIR)/$*.d $(OUTPUT_OPTION) $<
-
-$(ZSTD_STATLIB_DIR)/%.o : %.c $(ZSTD_STATLIB_DIR)/%.d | $(ZSTD_STATLIB_DIR)
-	@echo CC $@
-	$(COMPILE.c) $(DEPFLAGS) $(ZSTD_STATLIB_DIR)/$*.d $(OUTPUT_OPTION) $<
-
-$(ZSTD_DYNLIB_DIR)/%.o : %.S | $(ZSTD_DYNLIB_DIR)
-	@echo AS $@
-	$(COMPILE.c) $(OUTPUT_OPTION) $<
-
-$(ZSTD_STATLIB_DIR)/%.o : %.S | $(ZSTD_STATLIB_DIR)
-	@echo AS $@
-	$(COMPILE.c) $(OUTPUT_OPTION) $<
-
-MKDIR ?= mkdir
-$(BUILD_DIR) $(ZSTD_DYNLIB_DIR) $(ZSTD_STATLIB_DIR):
-	$(MKDIR) -p $@
-
-DEPFILES := $(ZSTD_DYNLIB_OBJ:.o=.d) $(ZSTD_STATLIB_OBJ:.o=.d)
-$(DEPFILES):
-
-include $(wildcard $(DEPFILES))
-
-
-# Special case : building library in single-thread mode _and_ without zstdmt_compress.c
-ZSTDMT_FILES = compress/zstdmt_compress.c
-ZSTD_NOMT_FILES = $(filter-out $(ZSTDMT_FILES),$(ZSTD_FILES))
-libzstd-nomt: CFLAGS += -fPIC -fvisibility=hidden
-libzstd-nomt: LDFLAGS += -shared
-libzstd-nomt: $(ZSTD_NOMT_FILES)
-	@echo compiling single-thread dynamic library $(LIBVER)
-	@echo files : $(ZSTD_NOMT_FILES)
-	$(CC) $(FLAGS) $^ $(LDFLAGS) $(SONAME_FLAGS) -o $@
-
-.PHONY: clean
-clean:
-	$(RM) -r *.dSYM   # macOS-specific
-	$(RM) core *.o *.a *.gcda *.$(SHARED_EXT) *.$(SHARED_EXT).* libzstd.pc
-	$(RM) dll/libzstd.dll dll/libzstd.lib libzstd-nomt*
-	$(RM) -r obj/*
-	@echo Cleaning library completed
-
-#-----------------------------------------------------------------------------
-# make install is validated only for below listed environments
-#-----------------------------------------------------------------------------
-ifneq (,$(filter $(UNAME),Linux Darwin GNU/kFreeBSD GNU OpenBSD FreeBSD NetBSD DragonFly SunOS Haiku AIX))
-
-lib: libzstd.pc
-
-HAS_EXPLICIT_EXEC_PREFIX := $(if $(or $(EXEC_PREFIX),$(exec_prefix)),1,)
-
-DESTDIR     ?=
-# directory variables : GNU conventions prefer lowercase
-# see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
-# support both lower and uppercase (BSD), use uppercase in script
-prefix      ?= /usr/local
-PREFIX      ?= $(prefix)
-exec_prefix ?= $(PREFIX)
-EXEC_PREFIX ?= $(exec_prefix)
-libdir      ?= $(EXEC_PREFIX)/lib
-LIBDIR      ?= $(libdir)
-includedir  ?= $(PREFIX)/include
-INCLUDEDIR  ?= $(includedir)
-
-PCINCDIR := $(patsubst $(PREFIX)%,%,$(INCLUDEDIR))
-PCLIBDIR := $(patsubst $(EXEC_PREFIX)%,%,$(LIBDIR))
-
-# If we successfully stripped off a prefix, we'll add a reference to the
-# relevant pc variable.
-PCINCPREFIX := $(if $(findstring $(INCLUDEDIR),$(PCINCDIR)),,$${prefix})
-PCLIBPREFIX := $(if $(findstring $(LIBDIR),$(PCLIBDIR)),,$${exec_prefix})
-
-# If no explicit EXEC_PREFIX was set by the caller, write it out as a reference
-# to PREFIX, rather than as a resolved value.
-PCEXEC_PREFIX := $(if $(HAS_EXPLICIT_EXEC_PREFIX),$(EXEC_PREFIX),$${prefix})
-
-ifneq (,$(filter $(UNAME),FreeBSD NetBSD DragonFly))
-  PKGCONFIGDIR ?= $(PREFIX)/libdata/pkgconfig
-else
-  PKGCONFIGDIR ?= $(LIBDIR)/pkgconfig
-endif
-
-ifneq (,$(filter $(UNAME),SunOS))
-  INSTALL ?= ginstall
-else
-  INSTALL ?= install
-endif
-
-INSTALL_PROGRAM ?= $(INSTALL)
-INSTALL_DATA    ?= $(INSTALL) -m 644
-
-
-libzstd.pc: libzstd.pc.in
-	@echo creating pkgconfig
-	@sed $(SED_ERE_OPT) \
-	        -e 's|@PREFIX@|$(PREFIX)|' \
-	        -e 's|@EXEC_PREFIX@|$(PCEXEC_PREFIX)|' \
-	        -e 's|@INCLUDEDIR@|$(PCINCPREFIX)$(PCINCDIR)|' \
-	        -e 's|@LIBDIR@|$(PCLIBPREFIX)$(PCLIBDIR)|' \
-	        -e 's|@VERSION@|$(VERSION)|' \
-	        -e 's|@LIBS_PRIVATE@|$(LDFLAGS_DYNLIB)|' \
-	        $< >$@
-
-.PHONY: install
-install: install-pc install-static install-shared install-includes
-	@echo zstd static and shared library installed
-
-.PHONY: install-pc
-install-pc: libzstd.pc
-	[ -e $(DESTDIR)$(PKGCONFIGDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(PKGCONFIGDIR)/
-	$(INSTALL_DATA) libzstd.pc $(DESTDIR)$(PKGCONFIGDIR)/
-
-.PHONY: install-static
-install-static:
-	# only generate libzstd.a if it's not already present
-	[ -e libzstd.a ] || $(MAKE) libzstd.a-release
-	[ -e $(DESTDIR)$(LIBDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(LIBDIR)/
-	@echo Installing static library
-	$(INSTALL_DATA) libzstd.a $(DESTDIR)$(LIBDIR)
-
-.PHONY: install-shared
-install-shared:
-	# only generate libzstd.so if it's not already present
-	[ -e $(LIBZSTD) ] || $(MAKE) libzstd-release
-	[ -e $(DESTDIR)$(LIBDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(LIBDIR)/
-	@echo Installing shared library
-	$(INSTALL_PROGRAM) $(LIBZSTD) $(DESTDIR)$(LIBDIR)
-	ln -sf $(LIBZSTD) $(DESTDIR)$(LIBDIR)/libzstd.$(SHARED_EXT_MAJOR)
-	ln -sf $(LIBZSTD) $(DESTDIR)$(LIBDIR)/libzstd.$(SHARED_EXT)
-
-.PHONY: install-includes
-install-includes:
-	[ -e $(DESTDIR)$(INCLUDEDIR) ] || $(INSTALL) -d -m 755 $(DESTDIR)$(INCLUDEDIR)/
-	@echo Installing includes
-	$(INSTALL_DATA) zstd.h $(DESTDIR)$(INCLUDEDIR)
-	$(INSTALL_DATA) zstd_errors.h $(DESTDIR)$(INCLUDEDIR)
-	$(INSTALL_DATA) zdict.h $(DESTDIR)$(INCLUDEDIR)
-
-.PHONY: uninstall
-uninstall:
-	$(RM) $(DESTDIR)$(LIBDIR)/libzstd.a
-	$(RM) $(DESTDIR)$(LIBDIR)/libzstd.$(SHARED_EXT)
-	$(RM) $(DESTDIR)$(LIBDIR)/libzstd.$(SHARED_EXT_MAJOR)
-	$(RM) $(DESTDIR)$(LIBDIR)/$(LIBZSTD)
-	$(RM) $(DESTDIR)$(PKGCONFIGDIR)/libzstd.pc
-	$(RM) $(DESTDIR)$(INCLUDEDIR)/zstd.h
-	$(RM) $(DESTDIR)$(INCLUDEDIR)/zstd_errors.h
-	$(RM) $(DESTDIR)$(INCLUDEDIR)/zdict.h
-	@echo zstd libraries successfully uninstalled
-
-endif

data/ext/zstdruby/libzstd/README.md

@@ -1,217 +0,0 @@
-Zstandard library files
-================================
-
-The __lib__ directory is split into several sub-directories,
-in order to make it easier to select or exclude features.
-
-
-#### Building
-
-`Makefile` script is provided, supporting [Makefile conventions](https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html#Makefile-Conventions),
-including commands variables, staged install, directory variables and standard targets.
-- `make` : generates both static and dynamic libraries
-- `make install` : install libraries and headers in target system directories
-
-`libzstd` default scope is pretty large, including compression, decompression, dictionary builder,
-and support for decoding legacy formats >= v0.5.0.
-The scope can be reduced on demand (see paragraph _modular build_).
-
-
-#### Multithreading support
-
-When building with `make`, by default the dynamic library is multithreaded and static library is single-threaded (for compatibility reasons).
-
-Enabling multithreading requires 2 conditions :
-- set build macro `ZSTD_MULTITHREAD` (`-DZSTD_MULTITHREAD` for `gcc`)
-- for POSIX systems : compile with pthread (`-pthread` compilation flag for `gcc`)
-
-For convenience, we provide a build target to generate multi and single threaded libraries:
-- Force enable multithreading on both dynamic and static libraries by appending `-mt` to the target, e.g. `make lib-mt`.
-- Force disable multithreading on both dynamic and static libraries by appending `-nomt` to the target, e.g. `make lib-nomt`.
-- By default, as mentioned before, dynamic library is multithreaded, and static library is single-threaded, e.g. `make lib`.
-
-When linking a POSIX program with a multithreaded version of `libzstd`,
-note that it's necessary to invoke the `-pthread` flag during link stage.
-
-Multithreading capabilities are exposed
-via the [advanced API defined in `lib/zstd.h`](https://github.com/facebook/zstd/blob/v1.4.3/lib/zstd.h#L351).
-
-
-#### API
-
-Zstandard's stable API is exposed within [lib/zstd.h](zstd.h).
-
-
-#### Advanced API
-
-Optional advanced features are exposed via :
-
-- `lib/zstd_errors.h` : translates `size_t` function results
-                        into a `ZSTD_ErrorCode`, for accurate error handling.
-
-- `ZSTD_STATIC_LINKING_ONLY` : if this macro is defined _before_ including `zstd.h`,
-                          it unlocks access to the experimental API,
-                          exposed in the second part of `zstd.h`.
-                          All definitions in the experimental APIs are unstable,
-                          they may still change in the future, or even be removed.
-                          As a consequence, experimental definitions shall ___never be used with dynamic library___ !
-                          Only static linking is allowed.
-
-
-#### Modular build
-
-It's possible to compile only a limited set of features within `libzstd`.
-The file structure is designed to make this selection manually achievable for any build system :
-
-- Directory `lib/common` is always required, for all variants.
-
-- Compression source code lies in `lib/compress`
-
-- Decompression source code lies in `lib/decompress`
-
-- It's possible to include only `compress` or only `decompress`, they don't depend on each other.
-
-- `lib/dictBuilder` : makes it possible to generate dictionaries from a set of samples.
-        The API is exposed in `lib/dictBuilder/zdict.h`.
-        This module depends on both `lib/common` and `lib/compress` .
-
-- `lib/legacy` : makes it possible to decompress legacy zstd formats, starting from `v0.1.0`.
-        This module depends on `lib/common` and `lib/decompress`.
-        To enable this feature, define `ZSTD_LEGACY_SUPPORT` during compilation.
-        Specifying a number limits versions supported to that version onward.
-        For example, `ZSTD_LEGACY_SUPPORT=2` means : "support legacy formats >= v0.2.0".
-        Conversely, `ZSTD_LEGACY_SUPPORT=0` means "do __not__ support legacy formats".
-        By default, this build macro is set as `ZSTD_LEGACY_SUPPORT=5`.
-        Decoding supported legacy format is a transparent capability triggered within decompression functions.
-        It's also allowed to invoke legacy API directly, exposed in `lib/legacy/zstd_legacy.h`.
-        Each version does also provide its own set of advanced API.
-        For example, advanced API for version `v0.4` is exposed in `lib/legacy/zstd_v04.h` .
-
-- While invoking `make libzstd`, it's possible to define build macros
-        `ZSTD_LIB_COMPRESSION, ZSTD_LIB_DECOMPRESSION`, `ZSTD_LIB_DICTBUILDER`,
-        and `ZSTD_LIB_DEPRECATED` as `0` to forgo compilation of the
-        corresponding features. This will also disable compilation of all
-        dependencies (eg. `ZSTD_LIB_COMPRESSION=0` will also disable
-        dictBuilder).
-
-- There are a number of options that can help minimize the binary size of
-  `libzstd`.
-
-  The first step is to select the components needed (using the above-described
-  `ZSTD_LIB_COMPRESSION` etc.).
-
-  The next step is to set `ZSTD_LIB_MINIFY` to `1` when invoking `make`. This
-  disables various optional components and changes the compilation flags to
-  prioritize space-saving.
-
-  Detailed options: Zstandard's code and build environment is set up by default
-  to optimize above all else for performance. In pursuit of this goal, Zstandard
-  makes significant trade-offs in code size. For example, Zstandard often has
-  more than one implementation of a particular component, with each
-  implementation optimized for different scenarios. For example, the Huffman
-  decoder has complementary implementations that decode the stream one symbol at
-  a time or two symbols at a time. Zstd normally includes both (and dispatches
-  between them at runtime), but by defining `HUF_FORCE_DECOMPRESS_X1` or
-  `HUF_FORCE_DECOMPRESS_X2`, you can force the use of one or the other, avoiding
-  compilation of the other. Similarly, `ZSTD_FORCE_DECOMPRESS_SEQUENCES_SHORT`
-  and `ZSTD_FORCE_DECOMPRESS_SEQUENCES_LONG` force the compilation and use of
-  only one or the other of two decompression implementations. The smallest
-  binary is achieved by using `HUF_FORCE_DECOMPRESS_X1` and
-  `ZSTD_FORCE_DECOMPRESS_SEQUENCES_SHORT` (implied by `ZSTD_LIB_MINIFY`).
-
-  For squeezing the last ounce of size out, you can also define
-  `ZSTD_NO_INLINE`, which disables inlining, and `ZSTD_STRIP_ERROR_STRINGS`,
-  which removes the error messages that are otherwise returned by
-  `ZSTD_getErrorName` (implied by `ZSTD_LIB_MINIFY`).
-
-  Finally, when integrating into your application, make sure you're doing link-
-  time optimization and unused symbol garbage collection (via some combination of,
-  e.g., `-flto`, `-ffat-lto-objects`, `-fuse-linker-plugin`,
-  `-ffunction-sections`, `-fdata-sections`, `-fmerge-all-constants`,
-  `-Wl,--gc-sections`, `-Wl,-z,norelro`, and an archiver that understands
-  the compiler's intermediate representation, e.g., `AR=gcc-ar`). Consult your
-  compiler's documentation.
-
-- While invoking `make libzstd`, the build macro `ZSTD_LEGACY_MULTITHREADED_API=1`
-  will expose the deprecated `ZSTDMT` API exposed by `zstdmt_compress.h` in
-  the shared library, which is now hidden by default.
-
-- The build macro `DYNAMIC_BMI2` can be set to 1 or 0 in order to generate binaries
-  which can detect at runtime the presence of BMI2 instructions, and use them only if present.
-  These instructions contribute to better performance, notably on the decoder side.
-  By default, this feature is automatically enabled on detecting
-  the right instruction set (x64) and compiler (clang or gcc >= 5).
-  It's obviously disabled for different cpus,
-  or when BMI2 instruction set is _required_ by the compiler command line
-  (in this case, only the BMI2 code path is generated).
-  Setting this macro will either force to generate the BMI2 dispatcher (1)
-  or prevent it (0). It overrides automatic detection.
-
-- The build macro `ZSTD_NO_UNUSED_FUNCTIONS` can be defined to hide the definitions of functions
-  that zstd does not use. Not all unused functions are hidden, but they can be if needed.
-  Currently, this macro will hide function definitions in FSE and HUF that use an excessive
-  amount of stack space.
-
-- The build macro `ZSTD_NO_INTRINSICS` can be defined to disable all explicit intrinsics.
-  Compiler builtins are still used.
-
-- The build macro `ZSTD_DECODER_INTERNAL_BUFFER` can be set to control
-  the amount of extra memory used during decompression to store literals.
-  This defaults to 64kB.  Reducing this value reduces the memory footprint of
-  `ZSTD_DCtx` decompression contexts,
-  but might also result in a small decompression speed cost.
-
-
-#### Windows : using MinGW+MSYS to create DLL
-
-DLL can be created using MinGW+MSYS with the `make libzstd` command.
-This command creates `dll\libzstd.dll` and the import library `dll\libzstd.lib`.
-The import library is only required with Visual C++.
-The header file `zstd.h` and the dynamic library `dll\libzstd.dll` are required to
-compile a project using gcc/MinGW.
-The dynamic library has to be added to linking options.
-It means that if a project that uses ZSTD consists of a single `test-dll.c`
-file it should be linked with `dll\libzstd.dll`. For example:
-```
-    gcc $(CFLAGS) -Iinclude/ test-dll.c -o test-dll dll\libzstd.dll
-```
-The compiled executable will require ZSTD DLL which is available at `dll\libzstd.dll`.
-
-
-#### Advanced Build options
-
-The build system requires a hash function in order to
-separate object files created with different compilation flags.
-By default, it tries to use `md5sum` or equivalent.
-The hash function can be manually switched by setting the `HASH` variable.
-For example : `make HASH=xxhsum`
-The hash function needs to generate at least 64-bit using hexadecimal format.
-When no hash function is found,
-the Makefile just generates all object files into the same default directory,
-irrespective of compilation flags.
-This functionality only matters if `libzstd` is compiled multiple times
-with different build flags.
-
-The build directory, where object files are stored
-can also be manually controlled using variable `BUILD_DIR`,
-for example `make BUILD_DIR=objectDir/v1`.
-In which case, the hash function doesn't matter.
-
-
-#### Deprecated API
-
-Obsolete API on their way out are stored in directory `lib/deprecated`.
-At this stage, it contains older streaming prototypes, in `lib/deprecated/zbuff.h`.
-These prototypes will be removed in some future version.
-Consider migrating code towards supported streaming API exposed in `zstd.h`.
-
-
-#### Miscellaneous
-
-The other files are not source code. There are :
-
- - `BUCK` : support for `buck` build system (https://buckbuild.com/)
- - `Makefile` : `make` script to build and install zstd library (static and dynamic)
- - `README.md` : this file
- - `dll/` : resources directory for Windows compilation
- - `libzstd.pc.in` : script for `pkg-config` (used in `make install`)