[3/4] btrfs-progs: Add btrfs wiki reference to man pages.

Commit Message

Qu Wenruo April 15, 2014, 7:04 a.m. UTC

Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and
btrfs-device as supplement.

Signed-off-by: Qu Wenruo <[e-mail]>
---
 Documentation/btrfs-check.txt   |  5 +++++
 Documentation/btrfs-device.txt  | 10 ++++++++--
 Documentation/btrfs-restore.txt |  4 ++++
 Documentation/btrfsck.txt       |  4 ++--
 4 files changed, 19 insertions(+), 4 deletions(-)

Comments

David Sterba April 15, 2014, 4:55 p.m. UTC | #1

On Tue, Apr 15, 2014 at 03:04:51PM +0800, Qu Wenruo wrote:
> Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and
> btrfs-device as supplement.

I'd rather avoid any references to 'btrfsck', it's been deprecated and
'btrfs check' should be used, thouth I'm sure there are enough people
used to 'btrfsck' and this will take time before we can drop it
completely.

I'll add this patch as-is for now, but before the new documentation is
released, at least the deprecatio notice should be there.
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt
index accbed4..ddd7fe7 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 <superblock>::
diff --git a/Documentation/btrfs-device.txt b/Documentation/btrfs-device.txt
index 523ae4d..7a6bce5 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 ea18ebb..72aa084 100644
--- a/Documentation/btrfs-restore.txt
+++ b/Documentation/btrfs-restore.txt
@@ -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::
diff --git a/Documentation/btrfsck.txt b/Documentation/btrfsck.txt
index 751c4d0..defac80 100644
--- a/Documentation/btrfsck.txt
+++ b/Documentation/btrfsck.txt
@@ -20,8 +20,8 @@  Now, it can only be run on an unmounted FS.
 
 WARNING: Considering it is not well-tested in real-life situations yet.
 If you have a broken Btrfs filesystem, btrfsck may not repair but cause
-additional damages. 
-
+additional damages. See the wiki page for more: +
+https://btrfs.wiki.kernel.org/index.php/Btrfsck
 
 OPTIONS
 -------