btrfs-progs: docs: update formatting of btrfs-property
authorDavid Sterba <dsterba@suse.com>
Wed, 31 May 2017 11:49:08 +0000 (13:49 +0200)
committerDavid Sterba <dsterba@suse.com>
Mon, 26 Jun 2017 15:08:18 +0000 (17:08 +0200)
Reported by a wiki user, that there are formatting artifacts in the
'get' section:

in html rendered as "The -t <em><type></em> option can be..."

This is probably due to the nesting '' and <>. We don't need the <> in
the explanation, as this is only to describe the command line syntax.

Signed-off-by: David Sterba <dsterba@suse.com>
Documentation/btrfs-property.asciidoc

index 8b9b7f0..05ab0bc 100644 (file)
@@ -28,14 +28,14 @@ A btrfs object, which is set by <object>, can be a btrfs filesystem
 itself, a btrfs subvolume, an inode(file or directory) inside btrfs,
 or a device on which a btrfs exists.
 +
-The '-t <type>' option can be used to explicitly
+The option '-t' can be used to explicitly
 specify what type of object you meant. This is only needed when a
 property could be set for more then one object type.
 +
 Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'.
 +
-Set the name of property by '<name>'. If no '<name>' is specified,
-all properties for the given object are printed. '<name>' is one of
+Set the name of property by 'name'. If no 'name' is specified,
+all properties for the given object are printed. 'name' is one of
 the followings.
 
 ro::::