Go to file
Goffredo Baroncelli 87d3875d4e Update/clean up btrfs help and man page V2
Hi all,

enclose you can find a patch which improves the help of the btrfs commands,
 updates the INSTALL file  and  the btrfs (command) man page.

Regarding the help of the btrfs command:
- moved the "subvolume set-default" command in the "subvolume" commands group
- removed a wrong new line
- small tweak on the basis of Andreas suggestion

Regarding the btrfs command man page:
- renaming the command "device balance" in "filesystem balance" (thanks to
Andreas Phillipp to highlight that)
- adding the entry "subvolume find-new"
- document the switches of the command "filesystem defrag"
- document the <devid> facility of the command "filesystem resize"
- small tweak on the basis of Andreas suggestion

Regarding the INSTALL file, which was very old, I removed the reference of the
old btrfsctl utility and changed the examples using the btrfs command.
I removed the old (and now wrong) statement about the inability to delete a
subvolume/snapshot

Chris, you can pull the patch from the branch "help_cleanup" of the following
repository.

http://cassiopea.homelinux.net/git/btrfs-progs-unstable.git

(or you can browse the changes at
http://cassiopea.homelinux.net/git/btrfs-progs-unstable.git/?p=btrfs-
progs-unstable-all.git;a=summary)

The patch is very simple: only updates the man page, the INSTALL file and
 moves/updates some lines in the help of btrfs command. Comments are welcome.

Regards
G.Baroncelli

 INSTALL        |   29 ++++++++++++++++++++---------
 btrfs.c        |   24 ++++++++++++------------
 man/btrfs.8.in |   45 +++++++++++++++++++++++++--------------------
 3 files changed, 57 insertions(+), 41 deletions(-)

 all the block devices.
 .TP
@@ -138,21 +143,21 @@ can expand the partition before enlarging the filesystem
and shrink the
 partition after reducing the size of the filesystem.
 .TP

-\fBfilesystem show\fR [<uuid>|<label>]\fR
-Show the btrfs filesystem with some additional info. If no UUID or label is
-passed, \fBbtrfs\fR show info of all the btrfs filesystem.
+\fBfilesystem show\fR [<device>|<uuid>|<label>]\fR
+Show the btrfs filesystem with some additional info. If no argument is
+passed, \fBbtrfs\fR shows info of all the btrfs filesystems.
 .TP

-\fBdevice balance\fR \fI<path>\fR
+\fBfilesystem balance\fR \fI<path>\fR
 Balance the chunks of the filesystem identified by \fI<path>\fR
 across the devices.
 .TP

-\fBdevice add\fR\fI <dev> [<dev>..] <path>\fR
+\fBdevice add\fR\fI <device> [<device>...] <path>\fR
 Add device(s) to the filesystem identified by \fI<path>\fR.
 .TP

-\fBdevice delete\fR\fI <dev> [<dev>..] <path>\fR
+\fBdevice delete\fR\fI <device> [<device>...] <path>\fR
 Remove device(s) from a filesystem identified by \fI<path>\fR.
 .PP

Signed-off-by: Chris Mason <chris.mason@oracle.com>
2011-10-25 09:18:31 -04:00
man Update/clean up btrfs help and man page V2 2011-10-25 09:18:31 -04:00
.hgignore Add .hgignore file to ignore verison.h 2008-07-23 11:36:13 -04:00
.hgtags Added tag v0.16 for changeset 2b26e4f8c71e 2008-08-04 15:46:36 -04:00
COPYING fix COPYING 2007-06-12 15:41:08 -04:00
INSTALL Update/clean up btrfs help and man page V2 2011-10-25 09:18:31 -04:00
Makefile Btrfs-progs: add a btrfs-select-super command to overwrite the super 2011-10-25 09:18:31 -04:00
bcp bcp updates for single file copies 2008-05-02 16:12:02 -04:00
bit-radix.c Make btrfs-progs compile with -fstrict-aliasing (included in -O2) again. 2007-09-14 10:31:06 -04:00
bit-radix.h add GPLv2 2007-06-12 09:07:11 -04:00
btrfs-defrag.c new util: 'btrfs' 2010-03-11 13:45:47 -05:00
btrfs-image.c Mixed back reference (FORWARD ROLLING FORMAT CHANGE) 2009-06-08 13:30:36 -04:00
btrfs-list.c Improve error handling in the btrfs command 2011-10-25 09:18:31 -04:00
btrfs-map-logical.c Fix the help text for btrfs-map-logical 2011-04-22 14:52:28 -04:00
btrfs-select-super.c Btrfs-progs: add a btrfs-select-super command to overwrite the super 2011-10-25 09:18:31 -04:00
btrfs-show.c Print the version string in a few programs 2008-07-24 12:13:30 -04:00
btrfs-vol.c Btrfs-progs: add support for mixed data+metadata block groups 2011-10-25 09:18:31 -04:00
btrfs-zero-log.c Add rescue command to zero the log 2010-10-05 10:14:48 -04:00
btrfs.c Update/clean up btrfs help and man page V2 2011-10-25 09:18:31 -04:00
btrfs_cmds.c Update for lzo support 2011-10-25 09:18:31 -04:00
btrfs_cmds.h Add btrfs subvol find-new command 2010-03-18 12:32:32 -04:00
btrfsck.c Add btrfsck option to select the super block copy 2010-10-04 15:41:10 -04:00
btrfsctl.c Btrfs-progs use safe string manipulation functions 2011-10-25 09:18:31 -04:00
btrfstune.c update btrfs-progs for seed device support 2008-11-18 10:40:06 -05:00
convert.c Btrfs-progs use safe string manipulation functions 2011-10-25 09:18:31 -04:00
crc32c.c CRC32C big endian bugs... 2008-02-15 11:20:02 -05:00
crc32c.h Mixed back reference (FORWARD ROLLING FORMAT CHANGE) 2009-06-08 13:30:36 -04:00
ctree.c Update converter for the new format 2009-06-08 13:31:10 -04:00
ctree.h Update for lzo support 2011-10-25 09:18:31 -04:00
debug-tree.c btrfs-debug-tree: add -d option to print only the device mapping 2010-10-06 09:53:38 -04:00
dir-item.c Btrfs: update converter for the new disk format 2008-12-17 16:10:07 -05:00
dir-test.c Btrfs: add btrfs-debug-tree -b <block number> to print a single block 2010-04-06 09:30:17 -04:00
disk-io.c Btrfs-progs: add a btrfs-select-super command to overwrite the super 2011-10-25 09:18:31 -04:00
disk-io.h Btrfs-progs: add a btrfs-select-super command to overwrite the super 2011-10-25 09:18:31 -04:00
extent-cache.c Add support for multiple devices per filesystem 2008-03-24 15:03:18 -04:00
extent-cache.h Add semantic checks to btrfsck for files and directories 2009-01-07 14:57:12 -05:00
extent-tree.c Check for RAID10 in set_avail_alloc_bits 2011-04-22 14:52:40 -04:00
extent_io.c Mixed back reference (FORWARD ROLLING FORMAT CHANGE) 2009-06-08 13:30:36 -04:00
extent_io.h Verify parent generation number on btree reads 2008-05-13 13:48:58 -04:00
file-item.c Fix isize/nbytes update bugs in btrfs-convert 2009-01-12 12:47:06 -05:00
hash.h Switch btrfs_name_hash() to crc32c 2008-08-20 20:11:23 -04:00
hasher.c Unaligned access fixes 2008-02-15 11:19:58 -05:00
inode-item.c btrfs-progs new dir index support 2008-07-24 12:13:32 -04:00
inode-map.c btrfs-progs: Fix printf format casting errors 2008-04-01 10:52:22 -04:00
ioctl-test.c Add ioctl-test.c which just prints all the ioctl numbers. 2010-03-15 11:24:20 -04:00
ioctl.h Update for lzo support 2011-10-25 09:18:31 -04:00
kerncompat.h multidevice support for check_mounted 2010-09-23 20:26:49 -04:00
list.h Dynamic chunk allocation 2008-03-24 15:03:58 -04:00
mkfs.c Btrfs-progs: add support for mixed data+metadata block groups 2011-10-25 09:18:31 -04:00
print-tree.c only print FIRST_CHUNK_TREE for chunk items in debug-tree 2010-09-23 20:26:49 -04:00
print-tree.h Btrfs: add btrfs-debug-tree -b <block number> to print a single block 2010-04-06 09:30:17 -04:00
quick-test.c Btrfs: add btrfs-debug-tree -b <block number> to print a single block 2010-04-06 09:30:17 -04:00
radix-tree.c Make btrfs-progs compile with -fstrict-aliasing (included in -O2) again. 2007-09-14 10:31:06 -04:00
radix-tree.h i386 fixes from axboe 2007-06-12 11:39:09 -04:00
random-test.c Btrfs: add btrfs-debug-tree -b <block number> to print a single block 2010-04-06 09:30:17 -04:00
rbtree.c Stop using radix trees to record pending allocations 2007-10-15 16:25:04 -04:00
rbtree.h Stop using radix trees to record pending allocations 2007-10-15 16:25:04 -04:00
root-tree.c Btrfs: update converter for the new disk format 2008-12-17 16:10:07 -05:00
show-blocks Fix showblocks to display different colors for different metadata roots 2009-03-09 13:00:44 -04:00
transaction.h Update btrfs-progs to match kernel sources 2008-01-04 10:38:22 -05:00
utils.c Btrfs-progs: add support for mixed data+metadata block groups 2011-10-25 09:18:31 -04:00
utils.h Btrfs-progs: add support for mixed data+metadata block groups 2011-10-25 09:18:31 -04:00
version.sh btrfs-progs v0.19 2009-06-11 12:56:15 -04:00
volumes.c Fill missing devices so degraded filesystems can be read 2011-04-22 14:52:40 -04:00
volumes.h superblock duplication 2008-12-05 12:21:31 -05:00