X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=INSTALL;h=819b92ea8bc057470abd6e2d19df8aa374c56d0b;hb=4523dc2776783ecd2fb1e3c72997f23ac2c3b975;hp=2f15e5e8e747d904a9bf161a57b529319aec2ea7;hpb=834b85e9f6753d61d4c0990545de77f0f3dbf6a1;p=platform%2Fupstream%2Fbtrfs-progs.git

diff --git a/INSTALL b/INSTALL
index 2f15e5e..819b92e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,57 +1,82 @@
-Install Instructions
+Installation instructions
+=========================
 
-Btrfs uses libcrc32c in the kernel for file and metadata checksums.  You need
-to compile the kernel with:
+The Btrfs utility programs require the following libraries/tools to build:
 
-CONFIG_LIBCRC32C=m
+- libuuid - provided by util-linux, e2fsprogs/e2fslibs or libuuid
+- libblkid - block device id library
+- liblzo2 - LZO data compression library
+- zlib - ZLIB data compression library
+- libzstd - ZSTD data compression library version >= 1.0.0
 
-libcrc32c can be static as well.  Once your kernel is setup, typing make in the
-btrfs module sources will build against the running kernel.  When the build is
-complete:
+For the btrfs-convert utility:
 
-modprobe libcrc32c
-insmod btrfs.ko
+- e2fsprogs - ext2/ext3/ext4 file system libraries, or called e2fslibs
+- libreiserfscore - reiserfs file system library version >= 3.6.27
 
-The Btrfs utility programs require libuuid to build.  This can be found
-in the e2fsprogs sources, and is usually available as libuuid or
-e2fsprogs-devel from various distros.
+Generating documentation:
 
-The Btrfs utility programs also require libblkid (block device identification
-library). This library is usually available as libblkid-dev or libblkid-devel.
+- asciidoc - text document format tool
+- xmlto - text document format tool
 
-Building the utilities is just make ; make install.  The programs go
-into /usr/local/bin.  The mains commands available are:
+XATTR library should be provided by the standard C library or by
 
-mkfs.btrfs: create a filesystem
+- libattr - extended attribute library
 
-btrfs: control program to create snapshots and subvolumes:
-	# mount a btrfs filesystem
-	mount /dev/sda2 /mnt
+Please note that the package names may differ according to the distribution.
+See https://btrfs.wiki.kernel.org/index.php/Btrfs_source_repositories#Dependencies .
 
-	# create a subvolume
-	btrfs subvolume create /mnt/new_subvol_name
 
-	# snapshot of a subvolume
-	btrfs subvolume snapshot /mnt/default /mnt/snapshot_of_default 
-	btrfs subvolume snapshot /mnt/snapshot_of_default \
-		/mnt/snapshot_of_a_snapshot
+Building from sources
+---------------------
 
-	# list of the subvolumes
-	ls /mnt
-	default snapshot_of_a_snapshot snapshot_of_new_subvol
-	new_subvol_name snapshot_of_default
+To build from git sources you need to generate the configure script using the
+autotools:
 
-	# removal of a subvolume or a snapshot
-	btrfs subvolume delete /mn/snapshot_of_a_snapshot
+    $ ./autogen.sh
 
-	# look a the btrfs man page for further information
-	man btrfs
+To build from the released tarballs:
 
-btrfsck: do a limited check of the FS extent trees.</li>
+    $ ./configure
+    $ make
+    $ make install
 
-btrfs-debug-tree: print all of the FS metadata in text form.  Example:
+You may disable building some parts like documentation, btrfs-convert or
+backtrace support. See ./configure --help for more.
 
-	btrfs-debug-tree /dev/sda2 >& big_output_file
+Specific CFLAGS or LDFLAGS should be set like
 
+    $ 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. There are further build tuning options
+documented in the Makefile.
 
+    $ make EXTRA_CFLAGS=-ggdb3
+
+The build utilizes autotools, dependencies for generating the configure
+scripts are:
+
+* autconf, autoheader
+* automake, aclocal
+* pkg-config
+
+
+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
+
+The resulting binaries have the '.static' suffix, the intermediate object
+files do not conflict with the normal (dynamic) build.
+
+
+References:
+* https://btrfs.wiki.kernel.org