path: root/Documentation
diff options
authorDavid Sterba <>2014-04-16 18:33:44 +0200
committerDavid Sterba <>2014-04-22 14:26:19 +0200
commitfddeecb7d424d5bb1a93a19a5e537057a4a7f597 (patch)
tree5f42903cf5db422ba42cb50af2e102110ced6c85 /Documentation
parentfd287d868f122c59d994ae38977fa3d552f86673 (diff)
btrfs-progs: doc: link btrfsck to btrfs-check
The 'btrfsck' command has been deprecated in favor of 'btrfs check'. For compatibility install a symlink to the btrfs-check.8 manpage. Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation')
4 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index ec8598bb..e22f5bca 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -48,6 +48,7 @@ XMLTO_EXTRA = -m manpage-bold-literal.xsl
GZIP = gzip
INSTALL ?= install
RM ?= rm -f
+LNS ?= ln -sf
BTRFS_VERSION = $(shell sed -n 's/.*BTRFS_BUILD_VERSION "Btrfs \(.*\)"/\1/p'\
@@ -73,6 +74,7 @@ install: install-man
install-man: man
$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
+ $(LNS) btrfs-check.8.gz $(DESTDIR)$(man8dir)
$(RM) *.xml *.xml+ *.8 *.8.gz
diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt
index ddd7fe77..485a49cb 100644
--- a/Documentation/btrfs-check.txt
+++ b/Documentation/btrfs-check.txt
@@ -18,6 +18,8 @@ command, it is *highly* recommended to read the following btrfs wiki before
executing 'btrfs check' with '--repair' option: +
+'btrfsck' is an alias of 'btrfs check' command and is now deprecated.
-s|--support <superblock>::
@@ -47,4 +49,3 @@ SEE ALSO
diff --git a/Documentation/btrfs-restore.txt b/Documentation/btrfs-restore.txt
index 72aa0847..c1d1607a 100644
--- a/Documentation/btrfs-restore.txt
+++ b/Documentation/btrfs-restore.txt
@@ -14,7 +14,7 @@ DESCRIPTION
'btrfs restore' is used to try to salvage files from a damaged filesystem and
restore them into <path> or just list the tree roots.
-Since current `btrfsck`(8) or `btrfs-rescue`(8) only has very limited usage,
+Since current `btrfs-check`(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
diff --git a/Documentation/mkfs.btrfs.txt b/Documentation/mkfs.btrfs.txt
index bafe0652..7ce00961 100644
--- a/Documentation/mkfs.btrfs.txt
+++ b/Documentation/mkfs.btrfs.txt
@@ -130,4 +130,4 @@ further details.