btrfs-progs: Add btrfs wiki reference to man pages.
authorQu Wenruo <quwenruo@cn.fujitsu.com>
Tue, 15 Apr 2014 07:04:51 +0000 (15:04 +0800)
committerDavid Sterba <dsterba@suse.cz>
Tue, 22 Apr 2014 12:15:25 +0000 (14:15 +0200)
Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and
btrfs-device as supplement.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
Documentation/btrfs-check.txt
Documentation/btrfs-device.txt
Documentation/btrfs-restore.txt

index accbed4..ddd7fe7 100644 (file)
@@ -13,6 +13,11 @@ DESCRIPTION
 -----------
 'btrfs check' is used to check or repair a btrfs filesystem offline.
 
+NOTE: Since btrfs is under heavy development especially the 'btrfs check'
+command, it is *highly* recommended to read the following btrfs wiki before
+executing 'btrfs check' with '--repair' option: +
+https://btrfs.wiki.kernel.org/index.php/Btrfsck
+
 OPTIONS
 -------
 -s|--support <superblock>::
index 523ae4d..7a6bce5 100644 (file)
@@ -24,16 +24,22 @@ online.
 
 Profile::
 Btrfs filesystem uses data/metadata profiles to manage allocation/duplication
-mechanism. Profiles like RAID level can be assigned to data and metadata separately.
+mechanism. +
+Profiles like RAID level can be assigned to data and metadata separately.
 +
 See `mkfs.btrfs`(8) for more details.
 
 RAID level::
-Btrfs filesystem supports most of the standard RAID level: 0/1/5/6/10.
+Btrfs filesystem supports most of the standard RAID level: 0/1/5/6/10. +
 RAID levels can be assigned at mkfs time or online.
 +
 See `mkfs.btrfs`(8) for mkfs time RAID level assign and `btrfs-balance`(8) for
 online RAID level assign.
++
+NOTE: Since btrfs is under heavy development especially the RAID5/6 support,
+it is *highly* recommended to read the follow btrfs wiki page to get more
+updated details on RAID5/6: +
+https://btrfs.wiki.kernel.org/index.php/RAID56
 
 Balance::
 `btrfs-balance`(8) subcommand can be used to balance or rebuild chunks to the
index ea18ebb..72aa084 100644 (file)
@@ -17,6 +17,10 @@ restore them into <path> or just list the tree roots.
 Since current `btrfsck`(8) or `btrfs-rescue`(8) only has very limited usage,
 'btrfs restore' is normally a better choice.
 
+NOTE: It is recommended to read the following btrfs wiki page if your data is
+not salvaged with default option: +
+https://btrfs.wiki.kernel.org/index.php/Restore
+
 OPTIONS
 -------
 -s::