From a11cd2b591f76373f75c1197501d7e816a663c9a Mon Sep 17 00:00:00 2001 From: Qu Wenruo Date: Tue, 15 Apr 2014 15:04:51 +0800 Subject: btrfs-progs: Add btrfs wiki reference to man pages. Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and btrfs-device as supplement. Signed-off-by: Qu Wenruo Signed-off-by: David Sterba --- Documentation/btrfs-check.txt | 5 +++++ Documentation/btrfs-device.txt | 10 ++++++++-- Documentation/btrfs-restore.txt | 4 ++++ 3 files changed, 17 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt index accbed4e..ddd7fe77 100644 --- a/Documentation/btrfs-check.txt +++ b/Documentation/btrfs-check.txt @@ -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 :: diff --git a/Documentation/btrfs-device.txt b/Documentation/btrfs-device.txt index 523ae4de..7a6bce5c 100644 --- a/Documentation/btrfs-device.txt +++ b/Documentation/btrfs-device.txt @@ -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 diff --git a/Documentation/btrfs-restore.txt b/Documentation/btrfs-restore.txt index ea18ebbd..72aa0847 100644 --- a/Documentation/btrfs-restore.txt +++ b/Documentation/btrfs-restore.txt @@ -17,6 +17,10 @@ restore them into 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:: -- cgit v1.2.3