Btrfs progs v4.13.3
[platform/upstream/btrfs-progs.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 85a839f..e7f8184 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -7,6 +7,7 @@ The Btrfs utility programs require the following libraries/tools to build:
 - libblkid - block device id library
 - liblzo2 - LZO data compression library
 - zlib - ZLIB data compression library
+- libzstd - ZSTD data compression library version >= 1.0.0 (optional)
 
 For the btrfs-convert utility:
 
@@ -31,26 +32,27 @@ Building from sources
 To build from git sources you need to generate the configure script using the
 autotools:
 
- $ ./autogen.sh
   $ ./autogen.sh
 
 To build from the released tarballs:
 
- $ ./configure
- $ make
- $ make install
   $ ./configure
   $ make
   $ make install
 
 You may disable building some parts like documentation, btrfs-convert or
 backtrace support. See ./configure --help for more.
 
 Specific CFLAGS or LDFLAGS should be set like
 
- $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
   $ CFLAGS=... LDFLAGS=... ./configure --prefix=/usr
 
 and not as arguments to make. You can specify additional flags to build via
 variables EXTRA_CFLAGS and EXTRA_LDFLAGS that get appended to the predefined
-values of the respective variables.
+values of the respective variables. There are further build tuning options
+documented in the Makefile.
 
- $ make EXTRA_CFLAGS=-ggdb3
   $ make EXTRA_CFLAGS=-ggdb3
 
 The build utilizes autotools, dependencies for generating the configure
 scripts are:
@@ -60,18 +62,18 @@ scripts are:
 * pkg-config
 
 
-Staticly built binaries
------------------------
+Statically built binaries
+-------------------------
 
 The makefiles are ready to let you build static binaries of the utilities. This
 may be handy in rescue environments. Your system has to provide static version
 of the libraries.
 
-$ make static
-$ make btrfs.static
-$ make btrfs-convert.static
+    $ make static
+    $ make btrfs.static
+    $ make btrfs-convert.static
 
-The resulting static binaries have the '.static' suffix, the intermediate object
+The resulting binaries have the '.static' suffix, the intermediate object
 files do not conflict with the normal (dynamic) build.