Commit Graph

682 Commits

Author SHA1 Message Date
David Sterba
7f7c13f486 btrfs-progs: doc: remove text for unmerged features
The asciidoc conversion was done on a development branch and there are
portions of text that do not reflect the code.

Signed-off-by: David Sterba <dsterba@suse.cz>
2014-05-19 17:52:54 +02:00
David Sterba
7ba6e8a22d btrfs-progs: doc: fix argument notation and typos
All user-supplied values should be enclosed in <...> to distinguish
them from verbatim strings.

Signed-off-by: David Sterba <dsterba@suse.cz>
2014-05-19 17:52:51 +02:00
David Sterba
fddeecb7d4 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 <dsterba@suse.cz>
2014-04-22 14:26:19 +02:00
Qu Wenruo
a11cd2b591 btrfs-progs: Add btrfs wiki reference to man pages.
Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and
btrfs-device as supplement.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:25 +02:00
Qu Wenruo
97822b5eea btrfs-progs: Convert man page for btrfs-property.
Convert the man page for the newly added btrfs-property subcommand.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:25 +02:00
Qu Wenruo
01c42d908a btrfs-progs: Convert man page for btrfs-restore.
Convert man page for btrfs-restore, which I forgot to convert in the
previous patchset. :P

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:25 +02:00
Qu Wenruo
dad1c8ba3a btrfs-progs: Add explain on btrfs-zero-log.
Add more explain on btrfs-zero-log about when to use it.

Reviewed-by: Marc MERLIN <marc@merlins.org>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:24 +02:00
Qu Wenruo
5dbedcc3e0 btrfs-progs: Add device management related paragraph.
Add device management related paragraph to better explain btrfs device
management.

Cc: Marc MERLIN <marc@merlins.org>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:24 +02:00
Qu Wenruo
7eb1c25e05 btrfs-progs: Convert man page for mkfs.btrfs.
Convert man page for mkfs.btrfs.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:24 +02:00
Qu Wenruo
81066737e7 btrfs-progs: Convert man page for fsck.btrfs.
Convert man page for fsck.btrfs.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
a743eb1fc7 btrfs-progs: Convert man page for btrfs-zero-log
Convert man page for btrfs-zero-log

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
f1f5b36226 btrfs-progs: Convert man page for btrfstune.
Convert man page for btrfstune.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
d28ca3ab17 btrfs-progs: Convert man page for btrfs-show-super.
Convert man page for btrfs-show-super.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
3d1aeaf1ab btrfs-progs: Convert man page for btrfs-map-logical.
Convert man page for btrfs-map-logical.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
f1d84c881a btrfs-progs: Convert man page for btrfs-image.
Convert man page for btrfs-image.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:23 +02:00
Qu Wenruo
b1cf361c96 btrfs-progs: Convert man page for btrfs-find-root.
Convert man page for btrfs-find-root.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:22 +02:00
Qu Wenruo
e7a2edd1b6 btrfs-progs: Convert man page for btrfs-debug-tree.
Convert man page for btrfs-debug-tree.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:22 +02:00
Qu Wenruo
f6203e9ff4 btrfs-progs: Convert man page for btrfs-convert.
Convert man page for btrfs-convert.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:22 +02:00
Qu Wenruo
bc341bbd16 btrfs-progs: Convert man page for btrfs-replace.
Convert man page for btrfs-replace.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:22 +02:00
Qu Wenruo
05c6d72830 btrfs-progs: Convert and enhance the man page of btrfs-qgroup.
Convert and enhance the man page of btrfs-qgroup.

The original man page for btrfs-qgroup subcommand is almost useless for
new user(like me), so adds more information on it.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:22 +02:00
Qu Wenruo
88b532914f btrfs-progs: Convert man page for btrfs-quota.
Convert man page for btrfs-quota.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:21 +02:00
Qu Wenruo
1a7a47c8e8 btrfs-progs: Convert man page for btrfs-receive.
Convert man page for btrfs-receive.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:21 +02:00
Qu Wenruo
1873426ece btrfs-progs: Convert man page for btrfs-send.
Convert man page for btrfs-send.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:21 +02:00
Qu Wenruo
17abe51d4e btrfs-progs: Convert man page for btrfs-inspect-internal
Convert man page for btrfs-inspect-internal.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:21 +02:00
Qu Wenruo
9184296d9d btrfs-progs: Convert man page for btrfs-rescue
Convert man page for btrfs-rescue.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:21 +02:00
Qu Wenruo
e3cd48c751 btrfs-progs: Convert man page for btrfs-check.
Convert man page for btrfs-check.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:20 +02:00
Qu Wenruo
8cf75a9a26 btrfs-progs: Convert man page for btrfs-scrub
Convert man page for btrfs-scrub.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:20 +02:00
Qu Wenruo
ba42a2e67f btrfs-progs: Convert man page for btrfs-device subcommand.
Convert man page for btrfs-device subcommand.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:20 +02:00
Qu Wenruo
db413a0c48 btrfs-progs: Convert man page for btrfs-balance.
Convert man page for btrfs-balance.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:20 +02:00
Qu Wenruo
1762675f67 btrfs-progs: Convert man page for filesystem subcommand.
Convert man page for filesystem subcommand.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:19 +02:00
Qu Wenruo
912dee0b75 btrfs-progs: Convert man page for btrfs-subvolume
Convert man page for btrfs-subvolume.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:19 +02:00
Qu Wenruo
f33d68b475 btrfs-progs: Introduce asciidoc based man page and btrfs man page.
The old man page of btrfs will grow larger with new functions adding to
btrfs-progs and harder to maintain because the reader-unfriendly roff
grammar and one LARGE btrfs.in.

This patch will introduce the simplified Documentation directory mainly
'stolen' from git and include the first man page for 'btrfs(8)'.
This time, man page will be written in human-friendly asciidoc grammar
and each commands of btrfs will have a separate man page, which I hope
can reduce the effort to maintain the man page.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-04-22 14:15:19 +02:00