Commit graph

7 commits

Author SHA1 Message Date
David Sterba 7ffccaf0c3 btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits:

* editors set highliting according to the extensions
* web access to the git repository (github) renders the .asciidoc
  files:
  * we can link to them from the wiki
  * the files are editable via browser and such editations can be
    submitted for merge easily

Signed-off-by: David Sterba <dsterba@suse.cz>
2015-04-14 17:41:27 +02:00
Qu Wenruo 39568fa417 btrfs-progs: Doc: Add explain on 'source' and 'target' for btrfs-image.
Add explain on 'source' and 'target', which is somewhat confusing for
users who want to restore dumped image.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
[reworded texts]
Signed-off-by: David Sterba <dsterba@suse.cz>
2015-01-21 17:23:23 +01:00
Wang Shilong 5374ebe042 Btrfs-progs: remove author and copyright info from man page
>From:
http://man7.org/linux/man-pages/man7/man-pages.7.html
...
AUTHORS lists authors of the documentation or program.Use of
an AUTHORS section is strongly discouraged. Generally,
it is better not to clutter every page with a list of
(over time potentially numerous) authors; if you write
or significantly amend a page, add a copyright notice
as a comment in the source file.  If you are the author
of a device driver and want to include an address for
reporting bugs, place this under the BUGS section.
...

Suggested-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-08-22 15:07:02 +02:00
Gui Hecheng 729c0da103 btrfs-progs: update manpage for btrfs-image with -m option added
The btrfs-image support multiple devices with -m specified.

Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-08-22 14:43:10 +02:00
David Sterba a4197dfe24 btrfs-progs: doc: make all commands and subcommands bold
Italic format is used for parameters and values.  also this makes the
text visually separated,

Signed-off-by: David Sterba <dsterba@suse.cz>
2014-05-19 17:54:10 +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
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