Hi, This patch improves the build section and adds the example/specimen usage section in the README file.
Signed-off-by: Arshad Hussain <[email protected]> ---- # cat 0001-Improve-README.patch >From a2aa7e7b8938f1190d1618a5dda9f5c32cf3215e Mon Sep 17 00:00:00 2001 From: Arshad Hussain <[email protected]> Date: Tue, 26 Feb 2019 10:30:04 +0530 Subject: [PATCH] Improve README This patch improves the build section and adds the example/specimen usage section in the README file. --- README | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 63 insertions(+), 3 deletions(-) diff --git a/README b/README index 4e34159..b5b605a 100644 --- a/README +++ b/README @@ -21,8 +21,14 @@ How to build with lz4 static library ./configure --with-lz4=<lz4 install path> eg. if lz4 lib has been installed into fold of /usr/local/lib ./configure --with-lz4=/usr/local/lib && make -Maybe you should run this first: - ./autogen.sh +On Fedora, static lz4 can be installed using: + yum install lz4-static.x86_64 +To build you should run this first: + $ ./autogen.sh + $ ./configure + $ make + +mkfs.erofs binary will be generated under mkfs folder. Usage: $ ./mkfs.erofs @@ -35,7 +41,61 @@ Usage: -d -- set debugging level <dbglvl> -z -- enable <compr_algri> compression (only lz4hc is supported) - target path, source directory are both needed. + Target path, source directory are both needed. + +Specimen Usage: +Create a temporary Disk +$ dd if=/dev/zero of=erofs_disk bs=512 count=23000 + +Create and populate source directory +$ mkdir -p srcd + +Our sample source directory contents +$ ls -ali srcd/ +total 44 +425555 drwxr-xr-x 2 root root 4096 Feb 23 06:55 . +425533 drwxr-xr-x 9 root root 4096 Feb 26 06:54 .. +422789 -rw-r--r-- 1 root root 0 Feb 22 14:52 ChangeLog +422793 -rw-r--r-- 1 root root 3195 Feb 23 06:55 configure.ac +422794 -rw-r--r-- 1 root root 25763 Feb 23 06:55 Makefile +422796 -rw-r--r-- 1 root root 1879 Feb 23 06:55 README + +Run mkfs.erofs +$ ./mkfs/mkfs.erofs ./erofs_disk ./srcd/ + c_version: [0.1 Feb 22 2019 14:13:38] + c_img_path: [./erofs_disk] + c_src_path: [/root/arshad/erofs-utils/srcd] + c_dbg_lvl: [ 0] + c_dry_run: [ 0] + c_alg_name: [ none] + c_compr_maxsz: [ 921600] + c_compr_lvl: [ 0] + c_compr_boundary: [ 128] + c_compr_ratio_limit: [ 100] + +Load erofs.ko module +$ insmod drivers/staging/erofs/erofs.ko + +Mount erofs_disk image +$ mount -t erofs erofs_disk /mnt/vg1 -o loop + +Check FS type mount reports +$ mount | grep erofs +/root/arshad/erofs-utils/erofs_disk on /mnt/vg1 type erofs (ro,relatime,user_xattr,acl) + +Check the contents of the mounted FS +$ ls -ali /mnt/vg1/ +total 31 + 4 -rw-r--r-- 1 root root 0 Feb 23 06:55 ChangeLog +896 -rw-r--r-- 1 root root 3195 Feb 23 06:55 configure.ac + 5 -rw-r--r-- 1 root root 25763 Feb 23 06:55 Makefile + 44 -rw-r--r-- 1 root root 1879 Feb 23 06:55 README + +Umount /mnt/vg1 +$ umount /mnt/vg1 + +Unload erofs module +$ rmmod erofs To: linux-erofs mailing list <[email protected]> -- 2.14.3
