chubin / chubin/cheat.sh

Info on `mkfs.exfat` is misleading

Open
#425 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
41.7k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

There are (at least) 2 sources for `mkfs.exfat` program:
1. https://github.com/exfatprogs/exfatprogs
2. https://github.com/relan/exfat

The current version
```
# mkfs.exfat
# Creates an exfat filesystem inside a partition.
# More information: .

# Create an exfat filesystem inside partition 1 on device b (`sdb1`):
mkfs.exfat /dev/sdb1

# Create filesystem with a volume-name:
mkfs.exfat -n volume_name /dev/sdb1

# Create filesystem with a volume-id:
mkfs.exfat -i volume_id /dev/sdb1
```
is adapted for `relan/exfat` version.

If it was adapted for `exfatprogs/exfatprogs` version, it would differ:
```
# mkfs.exfat
# Creates an exfat filesystem inside a partition.
# More information: . (or other manpage website?)

# Create an exfat filesystem inside partition 1 on device b (`sdb1`):
mkfs.exfat /dev/sdb1

# Create filesystem with a volume-label:
mkfs.exfat -L volume_label /dev/sdb1

# Create filesystem with a volume-guid: (i think this one performs different thing compared to the other version with -i volume_id flag)
mkfs.exfat -U volume_guid /dev/sdb1
```

Contributor guide

Open the contributing guide

Research direction

Start from the `mkfs.exfat` cheat sheet entry and compare its examples with the `relan/exfat` and `exfatprogs/exfatprogs` sources mentioned in the issue. Update the commands and man-page link to accurately identify the documented implementation, then verify that the options and descriptions match it.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.