thr3ads.net - Btrfs devel - [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck [Aug 2013]

If this information is useful, please help other people find it:
Share via:

Wang Shilong

2013-Aug-01 05:35 UTC

[PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/btrfsck.8.in | 35 ++++++++++++++++++++++++++++++-----
 1 file changed, 30 insertions(+), 5 deletions(-)

diff --git a/man/btrfsck.8.in b/man/btrfsck.8.in
index 5004ba0..6087c14 100644
--- a/man/btrfsck.8.in
+++ b/man/btrfsck.8.in
@@ -1,11 +1,35 @@
 .TH BTRFSCK 8
 .SH NAME
-btrfsck \- check a btrfs filesystem
+btrfsck \- check and repair of a Btrfs filesystem
 .SH SYNOPSIS
-.B btrfsck \fI device\fP
+.B btrfsck [\fIoptions\fP] \fI<device>\fP
 .SH DESCRIPTION
-\fBbtrfsck\fP is used to check a btrfs filesystem.
-\fIdevice\fP is the device file where the filesystem is stored.
+\fBbtrfsck\fP is used to check and optionally repair of a Btrfs filesystem.
Now, it can only be run on an unmounted FS. Considering it is not well-tested
+in real-life situations yet. if you have a broken Btrfs filesystem, btrfsck may
not repair but cause aditional damages. \fI<device>\fP is the device file
+where the filesystem is stored.
+
+\fIOptions\fP
+.IP "\fB-s,--super \fI<superblock>\fP" 5
+specify which superblock copy that you want to use.
+.IP "\fB--repair\fP" 5
+try to repair the filesystem.
+.IP "\fB--init-csum-tree\fP" 5
+create a new CRC tree.
+.IP "\fB--init-extent-tree\fP" 5
+create a new extent tree.
+
+.SH EXIT CODE
+\fBbtrfsck\fR will return 0 exit code if no error happened.
+Other exit code means some problems happened.
+
+.SH AUTHOR
+Written by Shilong Wang and Wenruo Qu.
+
+.SH COPYRIGHT
+Copyright \(co 2013 Fujitsu, Inc.
+License GPLv3: GNU GPL version 3 <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 btrfsck
 is part of btrfs-progs. Btrfs is currently under heavy development,
@@ -13,4 +37,5 @@ 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)
+.BR mkfs.btrfs (8),
+.BR btrfs (8)
-- 
1.8.0.1

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 02/10] Btrfs-progs: add missing man information for btrfs-debug-tree

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 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..ea097ca
--- /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 GPLv3: GNU GPL version 3 <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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 03/10] Btrfs-progs: add missing man page for btrfs-show-super

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile              |  2 +-
 man/btrfs-show-super.8.in | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 man/btrfs-show-super.8.in

diff --git a/man/Makefile b/man/Makefile
index e5c1f7c..b1d3645 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -12,7 +12,7 @@ man8dir = $(mandir)/man8
 .SUFFIXES: .in .gz
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
-	   btrfs-debug-tree.8.gz
+	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfs-show-super.8.in b/man/btrfs-show-super.8.in
new file mode 100644
index 0000000..6588d46
--- /dev/null
+++ b/man/btrfs-show-super.8.in
@@ -0,0 +1,36 @@
+.TH BTRFS-SHOW-SUPER 8
+.SH NAME
+btrfs-show-super \- show btrfs superblock information stored in devices
+.SH SYNOPSIS
+.B btrfs-show-super [\fIoptions\fP] \fI<dev>\fP [\fI<dev>...\fP]
+.SH DESCRIPTION
+\fBbtrfs-show-super\fP is used to print the information of superblock,
+you can specify which mirror to print out. In default, every device''s
+first superblock will be printed out.
+
+\fIOptions\fP
+.IP "\fB-a\fP" 5
+print all the superblock information, if this option is given,
''\fB-i\fP'' option will be ignored.
+.IP "\fB-i \fI<super_mirror>\fP" 5
+specify which mirror to print out. \fI<super_mirror>\fP is between 0 and
2. if several ''\fB-i \fI<super_mirror>\fP''\fR are given,
only the last one is valid.
+
+.SH EXIT CODE
+\fBbtrfs-show-super\fR will return 0 exit code 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-show-super
+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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 04/10] Btrfs-progs: add man page information for btrfs-find-root

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile              |  2 +-
 man/btrfs-find-root.8.in  | 36 ++++++++++++++++++++++++++++++++++++
 man/btrfs-show-super.8.in |  4 ++--
 3 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 man/btrfs-find-root.8.in

diff --git a/man/Makefile b/man/Makefile
index b1d3645..3d2e3ba 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -12,7 +12,7 @@ man8dir = $(mandir)/man8
 .SUFFIXES: .in .gz
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
-	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz
+	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfs-find-root.8.in b/man/btrfs-find-root.8.in
new file mode 100644
index 0000000..b98cc53
--- /dev/null
+++ b/man/btrfs-find-root.8.in
@@ -0,0 +1,36 @@
+.TH BTRFS-FIND-ROOT 8
+.SH NAME
+btrfs-find-root \- filter to find btrfs root.
+.SH SYNOPSIS
+.B btrfs-find-root [\fIoptions\fP] \fI<dev>\fP
+.SH DESCRIPTION
+\fBbtrfs-find-root\fP is used to find the satisfied root, you can filter by
root tree''s objectid, generation, level.
+
+\fIOptions\fP
+.IP "\fB-g \fI<generation>\fP" 5
+filter root tree by it''s original transaction id, tree root''s
generation in default.
+.IP "\fB-o \fI<objectid>\fP" 5
+filter root tree by it''s objectid,tree root''s objectid in
default.
+.IP "\fB-l \fI<level>\fP" 5
+filter root tree by B-+ tree''s level, level 0 in default.
+
+.SH EXIT CODE
+\fBbtrfs-find-root\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 GPLv3: GNU GPL version 3 <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-find-root
+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)
diff --git a/man/btrfs-show-super.8.in b/man/btrfs-show-super.8.in
index 6588d46..f7af33c 100644
--- a/man/btrfs-show-super.8.in
+++ b/man/btrfs-show-super.8.in
@@ -1,6 +1,6 @@
 .TH BTRFS-SHOW-SUPER 8
 .SH NAME
-btrfs-show-super \- show btrfs superblock information stored in devices
+btrfs-show-super \- show Btrfs superblock information stored in devices
 .SH SYNOPSIS
 .B btrfs-show-super [\fIoptions\fP] \fI<dev>\fP [\fI<dev>...\fP]
 .SH DESCRIPTION
@@ -23,7 +23,7 @@ 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>.
+License GPLv3: GNU GPL version 3 <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
-- 
1.8.0.1

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 05/10] Btrfs-progs: add man page information for btrfs-convert

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile           |  3 ++-
 man/btrfs-convert.8.in | 39 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 man/btrfs-convert.8.in

diff --git a/man/Makefile b/man/Makefile
index 3d2e3ba..a2201e8 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -12,7 +12,8 @@ man8dir = $(mandir)/man8
 .SUFFIXES: .in .gz
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
-	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz
+	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz \
+	   btrfs-convert.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfs-convert.8.in b/man/btrfs-convert.8.in
new file mode 100644
index 0000000..1183977
--- /dev/null
+++ b/man/btrfs-convert.8.in
@@ -0,0 +1,39 @@
+.TH BTRFS-CONVERT 8
+.SH NAME
+btrfs-convert \- convert ext2/3/4 to btrfs.
+.SH SYNOPSIS
+.B btrfs-convert [\fIoptions\fP] \fI<dev>\fP
+.SH DESCRIPTION
+\fBbtrfs-convert\fP is used to convert existed ext2/3/4 to btrfs filesystem,
and the original filesystem image is accessible as from separate subvolume named
ext2_subvol as file image.
+
+\fIOptions\fP
+.IP "\fB-d\fP" 5
+disable data checksum.
+.IP "\fB-i\fP" 5
+ignore xattrs and ACLs.
+.IP "\fB-n\fP" 5
+disable packing of small files.
+.IP "\fB-r\fP" 5
+roll back to ext2fs.
+
+.SH EXIT CODE
+\fBbtrfs-convert\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 GPLv3: GNU GPL version 3 <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-convert
+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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 06/10] Btrfs-progs: add missing man page for btrfstune

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile       |  2 +-
 man/btrfstune.8.in | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 man/btrfstune.8.in

diff --git a/man/Makefile b/man/Makefile
index a2201e8..e1246db 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -13,7 +13,7 @@ man8dir = $(mandir)/man8
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
 	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz \
-	   btrfs-convert.8.gz
+	   btrfs-convert.8.gz btrfstune.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfstune.8.in b/man/btrfstune.8.in
new file mode 100644
index 0000000..e0fb1fd
--- /dev/null
+++ b/man/btrfstune.8.in
@@ -0,0 +1,37 @@
+.TH BTRFSTUNE 8
+.SH NAME
+btrfstune \- tune various filesystem parameters.
+.SH SYNOPSIS
+.B btrfstune [\fIoptions\fP] \fI<mnt>\fP
+.SH DESCRIPTION
+\fBbtrfstune\fP is used to tune various filesystem parameters,you can
+enable/disable some extended features for btrfs.
+
+\fIOptions\fP
+.IP "\fB-S \fI<value>\fP" 5
+updates the seeding value, it forces a fs readonly so that you can use it to
build other filesystems.
+.IP "\fB-r\fP" 5
+enable extended inode refs.
+.IP "\fB-x\fP" 5
+enable skinny metadata extent refs.
+
+.SH EXIT CODE
+\fBbtrfstune\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 GPLv3: GNU GPL version 3 <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 btrfstune
+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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 07/10] Btrfs-progs: add missing man page information for btrfs-zero-log

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile            |  2 +-
 man/btrfs-zero-log.8.in | 29 +++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100644 man/btrfs-zero-log.8.in

diff --git a/man/Makefile b/man/Makefile
index e1246db..5ccb60a 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -13,7 +13,7 @@ man8dir = $(mandir)/man8
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
 	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz \
-	   btrfs-convert.8.gz btrfstune.8.gz
+	   btrfs-convert.8.gz btrfstune.8.gz btrfs-zero-log.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfs-zero-log.8.in b/man/btrfs-zero-log.8.in
new file mode 100644
index 0000000..68ebefd
--- /dev/null
+++ b/man/btrfs-zero-log.8.in
@@ -0,0 +1,29 @@
+.TH BTRFS-ZERO-LOG 8
+.SH NAME
+btrfs-zero-log \- clear out log tree.
+.SH SYNOPSIS
+.B btrfs-zero-log \fI <dev>\fP
+.SH DESCRIPTION
+\fBbtrfs-zero-log\fP will remove the log tree if log tree is corrupt, which
will allow you to mount the filesystem again. The common case where this
+happens has been fixed a long time ago, so it is unlikely that you will see
this particular problem.
+
+.SH EXIT CODE
+\fBbtrfs-zero-log\fR will return 0 exit code if no error happened.
+Other exit code means some problems happened.
+
+.SH AUTHOR
+Written by Shilong Wang and Wenruo Qu.
+
+.SH COPYRIGHT
+Copyright \(co 2013 Fujitsu, Inc.
+License GPLv3: GNU GPL version 3 <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-zero-log
+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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 08/10] btrfs-progs: Update usage string of btrfs-map-logical

btrfs-map-logical supports both short and long options, and also every option
should follow an arg,fix it.

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 btrfs-map-logical.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/btrfs-map-logical.c b/btrfs-map-logical.c
index b9635f7..e46d812 100644
--- a/btrfs-map-logical.c
+++ b/btrfs-map-logical.c
@@ -86,10 +86,14 @@ struct extent_buffer *debug_read_block(struct btrfs_root
*root, u64 bytenr,
 static void print_usage(void)
 {
 	fprintf(stderr, "usage: btrfs-map-logical [options] device\n");
-	fprintf(stderr, "\t-l Logical extent to map\n");
-	fprintf(stderr, "\t-c Copy of the extent to read (usually 1 or
2)\n");
-	fprintf(stderr, "\t-o Output file to hold the extent\n");
-	fprintf(stderr, "\t-b Number of bytes to read\n");
+	fprintf(stderr,
+		"\t-l|--logical <logical_num> Logical extent to map\n");
+	fprintf(stderr,
+		"\t-c|--copy <copy> Copy of the extent to read (usually 1 or
2)\n");
+	fprintf(stderr,
+		"\t-o|--output <filename> Output file to hold the extent\n");
+	fprintf(stderr,
+		"\t-b|--bytes <bytes> Number of bytes to read\n");
 	exit(1);
 }
 
-- 
1.8.0.1

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

From: Qu Wenruo <quwenruo@cn.fujitsu.com>

The ret variant in the main function is not changed so even problems
happen, return value is still 0.
The patch fixs the minor bug and return 1 if any problems happen.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 btrfs-map-logical.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/btrfs-map-logical.c b/btrfs-map-logical.c
index e46d812..7dc71d3 100644
--- a/btrfs-map-logical.c
+++ b/btrfs-map-logical.c
@@ -119,7 +119,6 @@ int main(int ac, char **av)
 	int copy = 0;
 	u64 bytes = 0;
 	int out_fd = 0;
-	int err;
 
 	while(1) {
 		int c;
@@ -187,8 +186,9 @@ int main(int ac, char **av)
 			out_fd = open(output_file, O_RDWR | O_CREAT, 0600);
 			if (out_fd < 0)
 				goto close;
-			err = ftruncate(out_fd, 0);
-			if (err) {
+			ret = ftruncate(out_fd, 0);
+			if (ret) {
+				ret = 1;
 				close(out_fd);
 				goto close;
 			}
@@ -205,8 +205,9 @@ int main(int ac, char **av)
 	while (bytes > 0) {
 		eb = debug_read_block(root, logical, root->sectorsize, copy);
 		if (eb && output_file) {
-			err = write(out_fd, eb->data, eb->len);
-			if (err < 0 || err != eb->len) {
+			ret = write(out_fd, eb->data, eb->len);
+			if (ret < 0 || ret != eb->len) {
+				ret = 1;
 				fprintf(stderr, "output file write failed\n");
 				goto out_close_fd;
 			}
-- 
1.8.0.1

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-01 05:35 UTC

head link

[PATCH 10/10] Btrfs-progs: add missing man page for btrfs-map-logical

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 man/Makefile               |  2 +-
 man/btrfs-map-logical.8.in | 39 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 man/btrfs-map-logical.8.in

diff --git a/man/Makefile b/man/Makefile
index 5ccb60a..690fa65 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -13,7 +13,7 @@ man8dir = $(mandir)/man8
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
 	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz \
-	   btrfs-convert.8.gz btrfstune.8.gz btrfs-zero-log.8.gz
+	   btrfs-convert.8.gz btrfstune.8.gz btrfs-zero-log.8.gz
btrfs-map-logical.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/btrfs-map-logical.8.in b/man/btrfs-map-logical.8.in
new file mode 100644
index 0000000..d2f867f
--- /dev/null
+++ b/man/btrfs-map-logical.8.in
@@ -0,0 +1,39 @@
+.TH BTRFS-MAP-LOGICAL 8
+.SH NAME
+btrfs-map-logical \- map btrfs logical extent to physical extent
+.SH SYNOPSIS
+.B btrfs-map-logical [\fIoptions\fP] \fI<device>\fP
+.SH DESCRIPTION
+\fBbtrfs-map-logical\fP can be used to find out what the physical offsets are
+on the mirrors, the result is dumped into stdout in default.
+
+\fIOptions\fP
+.IP "\fB-l|--logical \fI<logical_num>\fP" 5
+Logical extent to map.
+.IP "\fB-c|--copy \fI<copy>\fP" 5
+Copy of the extent to read(usually 1 or 2).
+.IP "\fB-o|--output \fI<filename>\fP" 5
+Output file to hold the extent.
+.IP "\fB-b|--bytes \fI<bytes>\fP" 5
+Number of bytes to read.
+
+.SH EXIT CODE
+\fBbtrfs-map-logical\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 GPLv3: GNU GPL version 3 <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-map-logical
+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

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Stefan Behrens

2013-Aug-01 09:43 UTC

head link

Re: [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

On Thu, 1 Aug 2013 13:35:25 +0800, Wang Shilong wrote:> Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
> Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
> ---
>  man/btrfsck.8.in | 35 ++++++++++++++++++++++++++++++-----
>  1 file changed, 30 insertions(+), 5 deletions(-)
> 
> diff --git a/man/btrfsck.8.in b/man/btrfsck.8.in
> index 5004ba0..6087c14 100644
> --- a/man/btrfsck.8.in
> +++ b/man/btrfsck.8.in
> @@ -1,11 +1,35 @@
>  .TH BTRFSCK 8
>  .SH NAME
> -btrfsck \- check a btrfs filesystem
> +btrfsck \- check and repair of a Btrfs filesystem
>  .SH SYNOPSIS
> -.B btrfsck \fI device\fP
> +.B btrfsck [\fIoptions\fP] \fI<device>\fP
>  .SH DESCRIPTION
> -\fBbtrfsck\fP is used to check a btrfs filesystem.
> -\fIdevice\fP is the device file where the filesystem is stored.
> +\fBbtrfsck\fP is used to check and optionally repair of a Btrfs
filesystem. Now, it can only be run on an unmounted FS. Considering it is not
well-tested
> +in real-life situations yet. if you have a broken Btrfs filesystem,
btrfsck may not repair but cause aditional damages. \fI<device>\fP is the
device file
> +where the filesystem is stored.
> +
> +\fIOptions\fP
> +.IP "\fB-s,--super \fI<superblock>\fP" 5
> +specify which superblock copy that you want to use.
> +.IP "\fB--repair\fP" 5
> +try to repair the filesystem.
> +.IP "\fB--init-csum-tree\fP" 5
> +create a new CRC tree.
> +.IP "\fB--init-extent-tree\fP" 5
> +create a new extent tree.
> +
> +.SH EXIT CODE
> +\fBbtrfsck\fR will return 0 exit code if no error happened.
> +Other exit code means some problems happened.
> +
> +.SH AUTHOR
> +Written by Shilong Wang and Wenruo Qu.
Please add the author Goldwyn Rodrigues.

You add text to the btrfsck manpage that Goldwyn Rodrigues has written
(according to git blame).
> +
> +.SH COPYRIGHT
> +Copyright \(co 2013 Fujitsu, Inc.
> +License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>.
Is GPLv3 tolerated in this area?	
> +.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 btrfsck
>  is part of btrfs-progs. Btrfs is currently under heavy development,
> @@ -13,4 +37,5 @@ 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)
> +.BR mkfs.btrfs (8),
> +.BR btrfs (8)
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

David Sterba

2013-Aug-06 13:48 UTC

head link

Re: [PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

On Thu, Aug 01, 2013 at 01:35:33PM +0800, Wang Shilong
wrote:> From: Qu Wenruo <quwenruo@cn.fujitsu.com>
> 
> The ret variant in the main function is not changed so even problems
> happen, return value is still 0.
> The patch fixs the minor bug and return 1 if any problems happen.
Please don''t mix code fixes into documentation updates next time
(unless
you''re testing my attention).

david
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Wang Shilong

2013-Aug-06 13:55 UTC

head link

Re: [PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

> On Thu, Aug 01, 2013 at 01:35:33PM +0800, Wang Shilong wrote:
>> From: Qu Wenruo <quwenruo@cn.fujitsu.com>
>> 
>> The ret variant in the main function is not changed so even problems
>> happen, return value is still 0.
>> The patch fixs the minor bug and return 1 if any problems happen.
> 
> Please don''t mix code fixes into documentation updates next time
(unless
> you''re testing my attention).
> 
I am sorry , we will take care of that.

Thanks,
Wang> david
> --
> To unsubscribe from this list: send the line "unsubscribe
linux-btrfs" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

David Sterba

2013-Aug-06 15:13 UTC

head link

Re: [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

On Thu, Aug 01, 2013 at 01:35:25PM +0800, Wang Shilong
wrote:> +.SH COPYRIGHT
> +Copyright \(co 2013 Fujitsu, Inc.
> +License GPLv3: GNU GPL version 3 <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.
Are you sure you want both a copyright statement and GPL wording here?

Another quiestion is about the GPL version itself, you''re releasing it
under v3 but the rest of the code is under v2 and there are issues when
these licenses are mixed.

I''d like to avoid any flames about v2 vs v3, so for ease of maintenance
please either drop the section or change it to gplv2. You''re free to
insist on v3, then I''m not going to merge the patches.

thanks,
david
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Btrfs devel - Aug 2013 - [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

[PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

[PATCH 02/10] Btrfs-progs: add missing man information for btrfs-debug-tree

[PATCH 03/10] Btrfs-progs: add missing man page for btrfs-show-super

[PATCH 04/10] Btrfs-progs: add man page information for btrfs-find-root

[PATCH 05/10] Btrfs-progs: add man page information for btrfs-convert

[PATCH 06/10] Btrfs-progs: add missing man page for btrfstune

[PATCH 07/10] Btrfs-progs: add missing man page information for btrfs-zero-log

[PATCH 08/10] btrfs-progs: Update usage string of btrfs-map-logical

[PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

[PATCH 10/10] Btrfs-progs: add missing man page for btrfs-map-logical

Re: [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck

Re: [PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

Re: [PATCH 09/10] btrfs-progs: Fix the return value of btrfs-map-logical

Re: [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck