Skip to content

Commit ca8902d

Browse files
committed
Update usage and README
1 parent d31064d commit ca8902d

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ format-udf was created to address some OS-specific quirks that prevent a naively
2626
* Windows does not support hard disks without a partition table. (This is strange because Windows does not apply the same limitation to flash drives.)
2727
* macOS seems to only mount UDF file systems that utilize the full disk (not just a partition)
2828

29-
At first glance, these constraints appear to be in partial conflict. The solution, as suggested by [Pieter](https://web.archive.org/web/20151103171649/http://sipa.ulyssis.org/2010/02/filesystems-for-portable-disks/), is to place a fake partition table (via [MBR](https://en.wikipedia.org/wiki/Master_boot_record)) in the first block of the drive, which lists a single entire-disk partition. This works because UDF (perhaps intentionally) doesn't utilize the first block. Unfortunately, there has been no easy way to do this, while juggling all of the other variables (such as device logical block size).
29+
At first glance, these constraints appear to be in partial conflict. The solution, as suggested by [Pieter](https://web.archive.org/web/20151103171649/http://sipa.ulyssis.org/2010/02/filesystems-for-portable-disks/), is to place a fake partition table (via [MBR](https://en.wikipedia.org/wiki/Master_boot_record)) in the first block of the drive, which lists a single entire-disk partition. This works because UDF (perhaps intentionally) doesn't utilize the first block. Unfortunately, there has been no easy way to do this, while juggling all of the other variables (such as device logical block size). format-udf writes such a fake MBR for added compatibility on Windows. If this is not what you desire, you can disable the MBR with `-p none`.
3030

31-
format-udf writes such a fake MBR for added compatibility on Windows. If this is not what you desire, you can disable the MBR with `-p none`.
31+
The goal of this project is to **provide access to a cross-platform file system with modern features**, in such a way that is:
32+
1. Easy to use for the average user
33+
2. Maximally compatible across operating systems
34+
3. As compliant as is reasonable with the UDF specification
35+
4. Maximally flexible to help users with uncommon needs
3236

3337

3438
# UDF OS Support
@@ -127,8 +131,7 @@ Usage: ./format-udf.sh [-b BLOCK_SIZE] [-f] [-p PARTITION_TYPE] [-w WIPE_METHOD
127131
-b BLOCK_SIZE
128132
Block size to be used during format operation.
129133
If absent, defaults to value reported by blockdev/diskutil.
130-
This is useful in light of the following Linux kernel bug:
131-
https://bugzilla.kernel.org/show_bug.cgi?id=102271
134+
This is an expert-only option. Please consult the README for details.
132135
133136
-f
134137
Forces non-interactive mode. Useful for scripting.
@@ -281,7 +284,7 @@ Please disconnect/reconnect your drive now.
281284
# Caveats
282285

283286
### Block Size
284-
If's extremely important that format-udf use the correct block size when formatting your drive. format-udf will attempt to detect and use the correct (logical) block size. However, in rare cases, Linux can [lie](https://bugzilla.kernel.org/show_bug.cgi?id=102271) about the block size. macOS is known to report the incorrect block size in certain scenarios as well. In these cases, the format-udf `-b BLOCK_SIZE` option can be used to explicitly override the detected block size value.
287+
If's extremely important that format-udf use the correct block size when formatting your drive. format-udf will attempt to detect and use the correct (logical) block size. If you know what you're doing, the format-udf `-b BLOCK_SIZE` option can be used to explicitly override the detected block size value.
285288

286289
If the wrong block size is used while formatting (i.e. one that doesn't match the logical block size of your drive), the resultant drive will likely have OS compatibility issues and suffer from non-optimal performance issues.
287290

format-udf.sh

+1-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ Usage: $0 [-b BLOCK_SIZE] [-f] [-p PARTITION_TYPE] [-w WIPE_METHOD] device labe
6060
-b BLOCK_SIZE
6161
Block size to be used during format operation.
6262
If absent, defaults to value reported by blockdev/diskutil.
63-
This is useful in light of the following Linux kernel bug:
64-
https://bugzilla.kernel.org/show_bug.cgi?id=102271
63+
This is an expert-only option. Please consult the README for details.
6564
6665
-f
6766
Forces non-interactive mode. Useful for scripting.

0 commit comments

Comments
 (0)