ceph-bluestore-tool manpage not getting rendered correctly
With older versions of Sphinx (looks like 1.2 and earlier), the rendering of the ".. option" directive is suboptimal.
As of (at least) Sphinx 1.3.6 the problem does not occur. But CentOS 7 has Sphinx 1.1.3.
When rendering the source file
/usr/share/man/man8/ceph-bluestore-tool.8, the lines
.. option:: bluefs-export Export the contents of BlueFS (i.e., rocksdb files) to an output directory.
get rendered as:
.B \-export Export the contents of BlueFS (i.e., rocksdb files) to an output directory.
Somehow the string before the first hyphen ("bluefs" in this case) is getting lost.
I have verified this by examining the following files:
and I have also reproduced in a CentOS 7 Docker container by doing the following:
./install-deps.sh ./do_cmake.sh -DWITH_MANPAGE=ON cd build make manpages
and examining the resulting file
Within the corpus of Ceph manpages, there are several that contain lists of subcommands. In some manpages the subcommands are marked up using ".. option", while in others the ":command:" syntax is used.
The ".. option" directive works for subcommands as long as they do not contain hyphens. See, for example "man ceph-dencoder".
Since the issue is not reproducible with newer versions of Sphinx, and thus can be expected to "go away eventually", it makes sense to merge a minimal fix - i.e. convert subcommand markup from "..option" to ":command:" but only in those manpages that have subcommands containing hyphens.
#1 Updated by Nathan Cutler about 3 years ago
- Status changed from New to In Progress
- Assignee set to Nathan Cutler
Looking at http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists I see what the problem is. In reStructuredText,
option is designed for options that start with a hyphen
-. So rST is just ignoring the characters that precede the first hyphen.
#3 Updated by Nathan Cutler about 3 years ago
Interestingly enough, the bug does not show up in the HTML version: http://docs.ceph.com/docs/master/man/8/ceph-bluestore-tool/
#4 Updated by Nathan Cutler about 3 years ago
The plot thickens. I can build the manpages by doing "./do_cmake.sh -DWITH_MANPAGE=ON ; cd build ; make manpages" but the resulting file ./doc/man/ceph-bluestore-tool.8 does not exhibit the bug.
Tried this in openSUSE Leap 42.3 with Sphinx 1.3.6 and in openSUSE Leap 15.0 with Sphinx 1.6.5.
Also, the ceph-bluestore-tool manpage in the ceph-osd (12.2.5) package that ships with Leap 42.3 does not exhibit the bug.
So, the bug is reproducible only in certain environments.