btrfs-progs: clarify mkfs.btrfs --alloc-start option
authorEric Sandeen <sandeen@redhat.com>
Thu, 15 May 2014 17:14:40 +0000 (19:14 +0200)
committerDavid Sterba <dsterba@suse.cz>
Fri, 22 Aug 2014 12:39:32 +0000 (14:39 +0200)
commit7165d9024df628593a6c6fe9fe50d02547105afc
tree7ebddd551863ac3ec64e95d5dd501f4fe8d2dd0d
parent834b85e9f6753d61d4c0990545de77f0f3dbf6a1
btrfs-progs: clarify mkfs.btrfs --alloc-start option

Fedora had a bug where a poor user thought that --alloc-start
meant that the filesystem would be created at that offset into
the device, rather than just starting allocations at that offset.
A subtle difference, but worth clarifying, because the manpage
is misleading on this point.

The original commit log for this option says:

    Add mkfs.btrfs -A offset to control allocation start on devices

    This is a utility option for the resizer, it makes sure to allocate
    at offset bytes in the disk or higher.  It ensures the resizer will have
    something to move when testing it.

so allude to that intended use in the manpage.

Signed-off-by: Eric Sandeen <sandeen@redhat.com>
[converted to asciidoc]
Signed-off-by: David Sterba <dsterba@suse.cz>
Documentation/mkfs.btrfs.txt