From: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
To: linux-btrfs@vger.kernel.org
Cc: dsterba@suse.cz
Subject: [v2 2/8] Btrfs-progs: add missing man information for btrfs-debug-tree
Date: Wed, 7 Aug 2013 13:54:03 +0800 [thread overview]
Message-ID: <1375854849-15224-2-git-send-email-wangsl.fnst@cn.fujitsu.com> (raw)
In-Reply-To: <1375854849-15224-1-git-send-email-wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
V1->V2: GPLv3->GPLv2
---
btrfs-debug-tree.c | 2 +-
man/Makefile | 3 ++-
man/btrfs-debug-tree.8.in | 41 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 44 insertions(+), 2 deletions(-)
create mode 100644 man/btrfs-debug-tree.8.in
diff --git a/btrfs-debug-tree.c b/btrfs-debug-tree.c
index bae7f94..dc912f1 100644
--- a/btrfs-debug-tree.c
+++ b/btrfs-debug-tree.c
@@ -195,7 +195,7 @@ int main(int ac, char **av)
if (!leaf) {
fprintf(stderr, "failed to read %llu\n",
(unsigned long long)block_only);
- return 0;
+ exit(1);
}
btrfs_print_tree(root, leaf, 0);
return 0;
diff --git a/man/Makefile b/man/Makefile
index 1ba23b5..e5c1f7c 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -11,7 +11,8 @@ man8dir = $(mandir)/man8
# list only those we use
.SUFFIXES: .in .gz
-MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz
+MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
+ btrfs-debug-tree.8.gz
INFILES = ${MANPAGES:.in=.gz}
all: $(MANPAGES)
diff --git a/man/btrfs-debug-tree.8.in b/man/btrfs-debug-tree.8.in
new file mode 100644
index 0000000..281fe98
--- /dev/null
+++ b/man/btrfs-debug-tree.8.in
@@ -0,0 +1,41 @@
+.TH BTRFS-DEBUG-TREE 8
+.SH NAME
+btrfs-debug-tree \- dump Btrfs filesystem metadata into stdout.
+.SH SYNOPSIS
+.B btrfs-debug-tree [\fIoptions\fP] \fI<device>\fP
+.SH DESCRIPTION
+\fBbtrfs-debug-tree\fP is used to dump the whole tree of the given device.
+This is maybe useful for analyzing filesystem state or inconsistence and has
+a positive educational effect on understanding the internal structure.
+\fIdevice\fP is the device file where the filesystem is stored.
+
+\fIOptions\fP
+.IP "\fB-e\fP" 5
+print detailed extents info.
+.IP "\fB-d\fP" 5
+print info of btrfs device and root tree dirs only.
+.IP "\fB-r\fP" 5
+print info of roots only.
+.IP "\fB-b \fI<block_num>\fP" 5
+print info of the specified block only.
+
+.SH EXIT CODE
+\fBbtrfs-debug-tree\fP will return 0 if no error happened.
+If any problems happened, 1 will be returned.
+
+.SH AUTHOR
+Written by Shilong Wang and Wenruo Qu.
+
+.SH COPYRIGHT
+Copyright \(co 2013 Fujitsu, Inc.
+License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
+.SH AVAILABILITY
+.B btrfs-debug-tree
+is part of btrfs-progs. Btrfs 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.
+.SH SEE ALSO
+.BR mkfs.btrfs (8)
--
1.8.0.1
next prev parent reply other threads:[~2013-08-07 5:55 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-07 5:54 [v2 1/8] Btrfs-progs: add missing man page information for btrfsck Wang Shilong
2013-08-07 5:54 ` Wang Shilong [this message]
2013-08-08 22:57 ` [v2 2/8] Btrfs-progs: add missing man information for btrfs-debug-tree David Sterba
2013-08-07 5:54 ` [v2 3/8] Btrfs-progs: add missing man page for btrfs-show-super Wang Shilong
2013-08-07 5:54 ` [v2 4/8] Btrfs-progs: add man page information for btrfs-find-root Wang Shilong
2013-08-07 6:46 ` Stefan Behrens
2013-08-07 8:35 ` Wang Shilong
2013-08-07 5:54 ` [v2 5/8] Btrfs-progs: add man page information for btrfs-convert Wang Shilong
2013-08-07 5:54 ` [v2 6/8] Btrfs-progs: add missing man page for btrfstune Wang Shilong
2013-08-07 5:54 ` [v2 7/8] Btrfs-progs: add missing man page information for btrfs-zero-log Wang Shilong
2013-08-07 5:54 ` [v2 8/8] Btrfs-progs: add missing man page for btrfs-map-logical Wang Shilong
2013-08-07 8:30 ` [patch v2 resend 4/8] Btrfs-progs: add man page information for btrfs-find-root Wang Shilong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1375854849-15224-2-git-send-email-wangsl.fnst@cn.fujitsu.com \
--to=wangsl.fnst@cn.fujitsu.com \
--cc=dsterba@suse.cz \
--cc=linux-btrfs@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).