Google Git
Sign in
android / platform / external / exfatprogs / d2c42e7
commitd2c42e7e13160e036df059b4b8804243bf7b941d[log] [tgz]
authorSven Hoexter <sven@stormbind.net>Fri Nov 29 21:50:38 2024 +0100
committerNamjae Jeon <linkinjeon@kernel.org>Mon Dec 02 08:49:01 2024 +0900
tree283d978eee5336d959a39138d8fe34452d56e74d
parent3fd43bb6744d33f7a1f05a3071ae2892a59f6198 [diff]
manpages: make sure to load the tbl preprocessor for the mkfs page

The manpage for mkfs makes use of the tbl(1) groff preprocessor
but does not ensure that it's loaded by man to its filter pipeline.

According to man(1):

    To contain a valid preprocessor string, the first line must resemble
    '\" <string>
     where string can be any combination of letters described by option -p below.

There `t` is listed for the tbl preprocessor.

The Debian linting tool lintian started to raise awareness for this
kind of issue. One can reproduce the testing condition used by lintian
locally by invoking the manpage via

    LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z mkfs.exfat.8 >/dev/null

Here the `MANROFFSEQ` environment variable is explicitly kept empty to
figure out if a preprocessor is missing.

Signed-off-by: Sven Hoexter <sven@stormbind.net>
Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>
1 file changed
tree: 283d978eee5336d959a39138d8fe34452d56e74d
  1. .github/
  2. dump/
  3. exfat2img/
  4. fsck/
  5. include/
  6. label/
  7. lib/
  8. manpages/
  9. mkfs/
  10. tests/
  11. tune/
  12. .editorconfig
  13. .gitignore
  14. .travis.yml
  15. .travis_get_mainline_kernel
  16. Android.bp
  17. autogen.sh
  18. configure.ac
  19. COPYING
  20. Makefile.am
  21. NEWS
  22. README.md
README.md

exfatprogs

As new exfat filesystem is merged into linux-5.7 kernel, exfatprogs is created as an official userspace utilities that contain all of the standard utilities for creating and fixing and debugging exfat filesystem in linux system. The goal of exfatprogs is to provide high performance and quality at the level of exfat utilities in windows. And this software is licensed under the GNU General Public License Version 2.

Building exfatprogs

Install prerequisite packages:

For Ubuntu:
    sudo apt-get install autoconf libtool pkg-config

For Fedora, RHEL:
    sudo yum install autoconf automake libtool

Build steps:

    cd into the exfatprogs directory:
    ./autogen.sh
    ./configure
    make
    make install

Using exfatprogs

- mkfs.exfat:
    Build a exfat filesystem on a device or partition(e.g. /dev/hda1, dev/sda1).

Usage example:
    1. No option(default) : cluster size adjustment as per device size, quick format.
        mkfs.exfat /dev/sda1
    2. To change cluster size(KB or MB or Byte) user want
        mkfs.exfat -c 1048576 /dev/sda1
        mkfs.exfat -c 1024K /dev/sda1
        mkfs.exfat -c 1M /dev/sda1
    3. For full format(zero out)
        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.

Usage example:
    1. check the consistency.
        fsck.exfat /dev/sda1
    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

Usage example:
    1. print current volume label.
        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.

Implementationversionexecution time (seconds)
exfatprogs fsck1.0.411.561
Windows fsckWindows 10 180911.449
exfat-fuse fsck1.3.068.977

Sending feedback

If you have any issues, please create issues or contact to Namjae Jeon and Hyunchul Lee. Contributions are also welcome.

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.