Add CVE ID to debian changelog

[sven/exfatprogs.git] / README.md

diff --git a/README.md b/README.md
index 48861d97aa3721931a147823debc57f34190d63a..d640c0691f99a765794a51774ab3b5c3c344e55b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,6 +42,10 @@ Usage example:
         mkfs.exfat -f /dev/sda1
     4. For set volume label, use -l option with string user want.
         mkfs.exfat -L "my usb" /dev/sda1
+    5. To change boundary alignment(KB or MB or Byte) user want
+        mkfs.exfat -b 16777216 /dev/sda1
+        mkfs.exfat -b 16384K /dev/sda1
+        mkfs.exfat -b 16M /dev/sda1
 
 - fsck.exfat:
     Check the consistency of your exfat filesystem and optionally repair a corrupted device formatted by exfat.
@@ -49,7 +53,10 @@ Usage example:
 Usage example:
     1. check the consistency.
         fsck.exfat /dev/sda1
-    2. repair and fix.(preparing)
+    2. repair a corrupted device and create files in /LOST+FOUND, which have clusters allocated but not belonged to any files when reparing the device.
+        fsck.exfat -p -s /dev/sda1
+    3. repair a corrupted device in the same way above, but answering yes to all questions.
+        fsck.exfat -y -s /dev/sda1
 
 - tune.exfat:
     Adjust tunable filesystem parameters on an exFAT filesystem
@@ -59,8 +66,55 @@ Usage example:
         tune.exfat -l /dev/sda1
     2. set new volume label.
         tune.exfat -L "new label" /dev/sda1
+    3. print current volume serial.
+        tune.exfat -i /dev/sda1
+    4. set new volume serial.
+        tune.exfat -I 0x12345678 /dev/sda1
+
+- exfatlabel:
+    Get or Set volume label or serial
+
+Usage example:
+    1. get current volume label.
+        exfatlabel /dev/sda1
+    2. set new volume label.
+        exfatlabel /dev/sda1 "new label"
+    3. get current volume serial.
+        exfatlabel -i /dev/sda1
+    4. set new volume serial.
+        exfatlabel -i /dev/sda1 0x12345678
+
+- dump.exfat:
+    Show on-disk information
+
+Usage example:
+    dump.exfat /dev/sda1
+
+- exfat2img:
+    Dump metadata of an exFAT filesystem
+
+Usage example:
+    exfat2img -o sda1.dump /dev/sda1
+
 ```
 
+## Benchmarks
+
+Some fsck implementations were tested and compared for Samsung 64GB Pro
+microSDXC UHS-I Class 10 which was filled up to 35GB with 9948 directories
+and 16506 files by fsstress.
+
+The difference in the execution time for each testing is very small.
+
+
+| Implementation       | version         | execution time (seconds) |
+|----------------------|-----------------|--------------------------|
+| **exfatprogs fsck**  | 1.0.4           | 11.561                   |
+| Windows fsck         | Windows 10 1809 | 11.449                   |
+| [exfat-fuse fsck]    | 1.3.0           | 68.977                   |
+
+[exfat-fuse fsck]: https://github.com/relan/exfat
+
 ## Sending feedback
 If you have any issues, please create [issues][1] or contact to [Namjae Jeon](mailto:linkinjeon@kernel.org) and
 [Hyunchul Lee](mailto:hyc.lee@gmail.com).
@@ -68,3 +122,8 @@ If you have any issues, please create [issues][1] or contact to [Namjae Jeon](ma
 
 [1]: https://github.com/exfatprogs/exfatprogs/issues
 [2]: https://github.com/exfatprogs/exfatprogs/pulls
+
+## Contributor information
+* Please base your pull requests on the `exfat-next` branch.
+* Make sure you add 'Signed-Off' information to your commits (e.g. `git commit --signoff`).
+* Please check your code contribution using kernel dev-tool script [checkpatch](https://docs.kernel.org/dev-tools/checkpatch.html).