[HADOOP-14482] Update BUILDING.txt to include the correct steps to install zstd library

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 3.0.0-alpha2
• Component/s: io
• Target Version/s: 3.5.0
• Assignee: Unassigned
• Reporter: Wei-Chiu Chuang
• Created: 02/Jun/17 18:36
• Updated: 04/Jan/24 12:07

Description

The current BUILDING.txt includes the following steps for installing zstd library:
$ sudo apt-get install zstd

This is incorrect. On my Ubuntu 16 machine, zstd is not a library

apt-cache search zstd
libzstd-dev - fast lossless compression algorithm – development files
libzstd0 - fast lossless compression algorithm
zstd - fast lossless compression algorithm – CLI tool

On a Ubuntu 14 machine, I couldn't even find anything related to zstd.

In fact, to build Hadoop with ZStandard library, I have to install libzstd-dev.
I will also need to install the runtime to use it. libzstd0 is the older version. libzstd1 is for zstd 1.x. It's not clear to me if libzstd0 is compatible. CentOS does have libzstd1 though.

Perhaps we can provide instruction to compile/install libzstd from source code.

• Use -Dzstd.prefix to specify a nonstandard location for the libzstd
  header files and library files. You do not need this option if you have
  installed zstandard using a package manager.

• Use -Dzstd.lib to specify a nonstandard location for the libzstd library
  files. Similarly to zstd.prefix, you do not need this option if you have
  installed using a package manager.

At least for CentOS, the library installed by rpm was not located and I had to specify -Dzstd.prefix to get it installed.

Issue Links

• depends upon: HADOOP-13578 Add Codec for ZStandard Compression