btrfs-progs/Documentation
Peter Wu 74f7b51c74 btrfs-progs: Documentation: fix broken conversion
Fixes various formatting issues:

Fixes quoting issues in various manpages. Before/After excerpts for
mkfs.btrfs(8), btrfs-qgroup(8):

    mkfs.btrfs [-A|--alloc-start '<alloc-start>']
    mkfs.btrfs [-A|--alloc-start <alloc-start>]
    id 0/<subvolume id>''
    id 0/<subvolume id>
    If multiple '<attr>'s is given, use comma to separate.
    If multiple <attr>s is given, use comma to separate.

The one that is most apparent is the removal of text in
btrfs-subvolume(8) and others. Before/After:

    list [options] [-G <value>] [-C <value>] [--sort=rootid,gen,ogen,path] <path>
    list [options] [-G [+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path>
    create [-i <qgroupid>] <name>
    create [-i <qgroupid>] [<dest>]<name>

This happens because `<foo>` was replaced by `'<foo>'` in the sed
expression, which is then treated as a constrained quote. As a result,
the `[...]` before the string gets interpreted as "quoted text
attributes".

In this patch, the sed expression is dropped and asciidoc is configured
to recognize `<...>` as a unconstrained quoted string (such that
`<attr>s` is correctly emphasized) and to avoid adding quotes in
contexts where it is not needed.

A remaining problem is that some texts (the one between brackets) do not
add the emphasis for `<...>`. While this could be solved by replacing
`[` and `]` with `&#91;` and `&#93;` using sed, it introduces formatting
problems in btrfs-zero-log(8) because the context is ignored.

Signed-off-by: Peter Wu <peter@lekensteyn.nl>
Signed-off-by: David Sterba <dsterba@suse.cz>
2015-01-09 18:36:50 +01:00
..
asciidoc.conf btrfs-progs: Documentation: fix broken conversion 2015-01-09 18:36:50 +01:00
btrfs-balance.txt btrfs-progs: doc, undocument old balance syntax 2015-01-03 02:30:38 +01:00
btrfs-check.txt btrfs-progs: check, update documentation 2014-12-18 16:04:10 +01:00
btrfs-convert.txt btrfs-progs: convert: use task for progress indication of metadata creation 2014-12-04 17:13:44 +01:00
btrfs-debug-tree.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs-device.txt btrfs-progs: doc device, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-filesystem.txt btrfs-progs: doc filesystem, sort subcommands alphabetically 2015-01-03 02:30:37 +01:00
btrfs-find-root.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs-image.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs-inspect-internal.txt btrfs-progs: doc inspect-internal, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-map-logical.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs-mount.txt btrfs-progs: add X inode flag to btrfs(5) 2014-08-22 14:43:12 +02:00
btrfs-property.txt btrfs-progs: doc property, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-qgroup.txt btrfs-progs: doc qgroup, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-quota.txt btrfs-progs: doc quota, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-receive.txt btrfs-progs: fix many typos in documents 2014-10-01 16:33:22 +02:00
btrfs-replace.txt btrfs-progs: doc replace, sort subcommands alphabetically 2015-01-03 02:30:38 +01:00
btrfs-rescue.txt btrfs-progs: fix many typos in documents 2014-10-01 16:33:22 +02:00
btrfs-restore.txt btrfs-progs: doc restore, cleanups for wiki conversion 2015-01-03 02:30:37 +01:00
btrfs-scrub.txt btrfs-progs: doc scrub, sort subcommands alphabetically 2015-01-03 02:30:39 +01:00
btrfs-send.txt btrfs-progs: fix many typos in documents 2014-10-01 16:33:22 +02:00
btrfs-show-super.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs-subvolume.txt btrfs-progs: doc subvolume, sort subcommands alphabetically 2015-01-03 02:30:39 +01:00
btrfs-zero-log.txt Btrfs-progs: remove author and copyright info from man page 2014-08-22 15:07:02 +02:00
btrfs.txt btrfs-progs: doc, undocument old balance syntax 2015-01-03 02:30:38 +01:00
btrfstune.txt btrfs-progs: update manpage with new option -f for btrfstune 2014-10-01 16:34:05 +02:00
fsck.btrfs.txt btrfs-progs: doc: make all commands and subcommands bold 2014-05-19 17:54:10 +02:00
Makefile btrfs-progs: Documentation: fix broken conversion 2015-01-09 18:36:50 +01:00
manpage-base.xsl btrfs-progs: Introduce asciidoc based man page and btrfs man page. 2014-04-22 14:15:19 +02:00
manpage-bold-literal.xsl btrfs-progs: Introduce asciidoc based man page and btrfs man page. 2014-04-22 14:15:19 +02:00
manpage-normal.xsl btrfs-progs: Introduce asciidoc based man page and btrfs man page. 2014-04-22 14:15:19 +02:00
mkfs.btrfs.txt btrfs-progs: doc mkfs, cleanups for wiki conversion 2015-01-03 02:30:37 +01:00