fsck.f2fs: allow to fsck readonly image w/ -f option
[platform/upstream/f2fs-tools.git] / README
1 F2FS format utilility
2 ---------------------
3
4 To use f2fs filesystem, you should format the storage partition
5 with this utilility. Otherwise, you cannot mount f2fs.
6
7 Before compilation
8 ------------------
9
10 You should install the following packages.
11  - libuuid-devel or uuid-dev
12  - pkg-config
13  - autoconf
14  - libtool
15  - libselinux1-dev
16
17 Initial compilation
18 -------------------
19
20 Before compilation initially, autoconf/automake tools should be run.
21
22  # ./autogen.sh
23
24 How to compile
25 --------------
26
27  # ./configure
28  # make
29  # make install
30
31 How to cross-compile (e.g., for ARM)
32 ------------------------------------
33
34  1. Add the below line into mkfs/Makefile.am:
35  mkfs_f2fs_LDFLAGS = -all-static
36
37  2. Add the below line into fsck/Makefile.am:
38  fsck_f2fs_LDFLAGS = -all-static
39
40  3. then, do:
41  # LDFLAGS=--static ./configure \
42         --host=arm-none-linux-gnueabi --target=arm-none-linux-gnueabi
43  # make
44
45 How to run by default
46 ---------------------
47
48  $ mkfs.f2fs -l [LABEL] $DEV
49
50 For more mkfs options, see man page.