[09/27] btrfs-progs: Convert man page for btrfs-inspect-internal
diff mbox

Message ID 1396427378-10487-10-git-send-email-quwenruo@cn.fujitsu.com
State Accepted
Delegated to: David Sterba
Headers show

Commit Message

Qu Wenruo April 2, 2014, 8:29 a.m. UTC
Convert man page for btrfs-inspect-internal.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 Documentation/Makefile                   |  2 +-
 Documentation/btrfs-inspect-internal.txt | 69 ++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/btrfs-inspect-internal.txt

Patch
diff mbox

diff --git a/Documentation/Makefile b/Documentation/Makefile
index ebe0455..6655f06 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -23,7 +23,7 @@  MAN8_TXT += btrfs-device.txt
 MAN8_TXT += btrfs-scrub.txt
 MAN8_TXT += btrfs-check.txt
 MAN8_TXT += btrfs-rescue.txt
-#MAN8_TXT += btrfs-inspect-internal.txt
+MAN8_TXT += btrfs-inspect-internal.txt
 #MAN8_TXT += btrfs-send.txt
 #MAN8_TXT += btrfs-receive.txt
 #MAN8_TXT += btrfs-quota.txt
diff --git a/Documentation/btrfs-inspect-internal.txt b/Documentation/btrfs-inspect-internal.txt
new file mode 100644
index 0000000..4555c70
--- /dev/null
+++ b/Documentation/btrfs-inspect-internal.txt
@@ -0,0 +1,69 @@ 
+btrfs-inspect-internal(8)
+=========================
+
+NAME
+----
+btrfs-inspect-internal - resolve different btrfs items for debug purpose
+
+SYNOPSIS
+--------
+'btrfs inspect-internal' <subcommand> <args>
+
+DESCRIPTION
+-----------
+'btrfs inspect-internal' is used to resolve different items for debug purpose.
+
+SUBCOMMAND
+----------
+'inode-resolve' [-v] <inode> <path>::
+Resolves an <inode> in subvolume <path> to all filesystem paths.
++
+`Options`
++
+-v::::
+verbose mode. print count of returned paths and ioctl() return value
+
+'logical-resolve' [-Pv] [-s bufsize] <logical> <path>::
+Resolves a <logical> address in the filesystem mounted at <path> to all inodes.
++
+By default, each inode is then resolved to a file system path (similar to the
+inode-resolve subcommand).
++
+`Options`
++
+-P::::
+skip the path resolving and print the inodes instead
+-v::::
+verbose mode. print count of returned paths and all ioctl() return values
+-s <bufsize>::::
+set inode container's size.
++
+This is used to increase inode container's size in case it is
+not enough to read all the resolved results. The max value one can set is 64k.
+
+'subvolid-resolve' <subvolid> <path>::
+Get file system paths for the given subvolume ID.
+
+'rootid' <path>::
+For a given file or directory, return the containing tree root id. For a
+subvolume return it's own tree id.
++
+The result is undefined for the so-called empty subvolumes (identified by inode number 2).
+
+EXIT STATUS
+-----------
+'btrfs inspect-internal' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+
+AVAILABILITY
+------------
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+development,
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
+further details.
+
+SEE ALSO
+--------
+`mkfs.btrfs`(8),
+`btrfs-debug-tree`(8)