]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: use :command: for subcommands in ceph-bluestore-tool manpage 23177/head
authorNathan Cutler <ncutler@suse.com>
Wed, 18 Jul 2018 12:01:42 +0000 (14:01 +0200)
committerNathan Cutler <ncutler@suse.com>
Mon, 23 Jul 2018 10:44:58 +0000 (12:44 +0200)
Older versions of Sphinx, such as the one in CentOS 7, do not render "..
option::" lines correctly if the option contains a hyphen but does not start
with a hyphen. And ceph-bluestore-tool appears to be the only Ceph manpage
affected by this bug.

Fixes: http://tracker.ceph.com/issues/24800
Signed-off-by: Nathan Cutler <ncutler@suse.com>
(cherry picked from commit 7c9229e7876dfc1bf6e415ed7cce924c3b50925d)

doc/man/8/ceph-bluestore-tool.rst

index 7a7b0ea6a47ae5204e4882b55726f47701c1d203..f5e5fe2b885c180084ce2a9b2793ffab89b30e69 100644 (file)
@@ -31,31 +31,31 @@ operations on a BlueStore instance.
 Commands
 ========
 
-.. option:: help
+:command:`help`
 
    show help
 
-.. option:: fsck
+:command:`fsck` [ --deep ]
 
    run consistency check on BlueStore metadata.  If *--deep* is specified, also read all object data and verify checksums.
 
-.. option:: repair
+:command:`repair`
 
    Run a consistency check *and* repair any errors we can.
 
-.. option:: bluefs-export
+:command:`bluefs-export`
 
    Export the contents of BlueFS (i.e., rocksdb files) to an output directory.
 
-.. option:: bluefs-bdev-sizes --path *osd path*
+:command:`bluefs-bdev-sizes` --path *osd path*
 
    Print the device sizes, as understood by BlueFS, to stdout.
 
-.. option:: bluefs-bdev-expand --path *osd path*
+:command:`bluefs-bdev-expand` --path *osd path*
 
    Instruct BlueFS to check the size of its block devices and, if they have expanded, make use of the additional space.
 
-.. option:: show-label --dev *device* [...]
+:command:`show-label` --dev *device* [...]
 
    Show device label(s).