nixpkgs/pkgs/tools/compression/zstd/default.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

113 lines
3.6 KiB
Nix
Raw Normal View History

{ lib, stdenv, fetchFromGitHub, cmake, bash, gnugrep
, fixDarwinDylibNames
2018-08-08 21:33:11 +00:00
, file
2021-08-17 00:52:13 +00:00
, fetchpatch
, legacySupport ? false
, static ? stdenv.hostPlatform.isStatic
# these need to be ran on the host, thus disable when cross-compiling
, buildContrib ? stdenv.hostPlatform == stdenv.buildPlatform
, doCheck ? stdenv.hostPlatform == stdenv.buildPlatform
, nix-update-script
}:
2016-01-27 01:45:20 +00:00
stdenv.mkDerivation rec {
2019-07-21 00:11:44 +00:00
pname = "zstd";
2022-01-27 19:53:38 +00:00
version = "1.5.2";
2016-01-27 01:45:20 +00:00
src = fetchFromGitHub {
owner = "facebook";
repo = "zstd";
rev = "v${version}";
2022-01-27 19:53:38 +00:00
sha256 = "sha256-yJvhcysxcbUGuDOqe/TQ3Y5xyM2AUw6r1THSHOqmUy0=";
2016-01-27 01:45:20 +00:00
};
nativeBuildInputs = [ cmake ]
2021-01-15 09:19:50 +00:00
++ lib.optional stdenv.isDarwin fixDarwinDylibNames;
buildInputs = lib.optional stdenv.hostPlatform.isUnix bash;
2019-11-12 20:49:47 +00:00
patches = [
# This patches makes sure we do not attempt to use the MD5 implementation
# of the host platform when running the tests
./playtests-darwin.patch
];
2019-11-12 20:49:47 +00:00
2021-01-15 09:19:50 +00:00
postPatch = lib.optionalString (!static) ''
substituteInPlace build/cmake/CMakeLists.txt \
--replace 'message(SEND_ERROR "You need to build static library to build tests")' ""
substituteInPlace build/cmake/tests/CMakeLists.txt \
--replace 'libzstd_static' 'libzstd_shared'
sed -i \
2021-01-15 09:19:50 +00:00
"1aexport ${lib.optionalString stdenv.isDarwin "DY"}LD_LIBRARY_PATH=$PWD/build_/lib" \
tests/playTests.sh
'';
2021-04-10 11:10:23 +00:00
cmakeFlags = lib.attrsets.mapAttrsToList
(name: value: "-DZSTD_${name}:BOOL=${if value then "ON" else "OFF"}") {
BUILD_SHARED = !static;
BUILD_STATIC = static;
BUILD_CONTRIB = buildContrib;
2021-04-10 11:10:23 +00:00
PROGRAMS_LINK_SHARED = !static;
LEGACY_SUPPORT = legacySupport;
BUILD_TESTS = doCheck;
};
cmakeDir = "../build/cmake";
dontUseCmakeBuildDir = true;
preConfigure = ''
mkdir -p build_ && cd $_
'';
2016-01-27 01:45:20 +00:00
2018-08-08 21:33:11 +00:00
checkInputs = [ file ];
inherit doCheck;
checkPhase = ''
runHook preCheck
# Patch shebangs for playTests
patchShebangs ../programs/zstdgrep
ctest -R playTests # The only relatively fast test.
runHook postCheck
2018-10-14 13:55:09 +00:00
'';
2018-08-08 21:33:11 +00:00
preInstall = ''
2021-06-30 22:14:57 +00:00
mkdir -p $bin/bin
substituteInPlace ../programs/zstdgrep \
--replace ":-grep" ":-${gnugrep}/bin/grep" \
--replace ":-zstdcat" ":-$bin/bin/zstdcat"
2017-05-10 17:52:34 +00:00
substituteInPlace ../programs/zstdless \
--replace "zstdcat" "$bin/bin/zstdcat"
'' + lib.optionalString buildContrib ''
cp contrib/pzstd/pzstd $bin/bin/pzstd
'' + lib.optionalString stdenv.isDarwin ''
install_name_tool -change @rpath/libzstd.1.dylib $out/lib/libzstd.1.dylib $bin/bin/pzstd
2017-05-10 17:52:34 +00:00
'';
2020-10-28 23:24:01 +00:00
outputs = [ "bin" "dev" ]
2021-01-15 09:19:50 +00:00
++ lib.optional stdenv.hostPlatform.isUnix "man"
2020-10-28 23:24:01 +00:00
++ [ "out" ];
passthru = {
updateScript = nix-update-script {
attrPath = pname;
};
};
meta = with lib; {
2016-01-27 01:45:20 +00:00
description = "Zstandard real-time compression algorithm";
longDescription = ''
Zstd, short for Zstandard, is a fast lossless compression algorithm,
targeting real-time compression scenarios at zlib-level compression
ratio. Zstd can also offer stronger compression ratio at the cost of
compression speed. Speed/ratio trade-off is configurable by small
increment, to fit different situations. Note however that decompression
speed is preserved and remain roughly the same at all settings, a
property shared by most LZ compression algorithms, such as zlib.
2016-01-27 01:45:20 +00:00
'';
homepage = "https://facebook.github.io/zstd/";
changelog = "https://github.com/facebook/zstd/blob/v${version}/CHANGELOG";
2019-07-21 00:11:44 +00:00
license = with licenses; [ bsd3 ]; # Or, at your opinion, GPL-2.0-only.
2016-01-27 01:45:20 +00:00
2019-11-12 20:49:47 +00:00
platforms = platforms.all;
maintainers = with maintainers; [ orivej ];
2016-01-27 01:45:20 +00:00
};
}