cmake: build man pages

[tchaikov]

Signed-off-by: Kefu Chai kchai@redhat.com

[tchaikov]

@cbodley would you mind taking a look?

[tchaikov]

we could use more sophisticated way to determine the section instead hard-wiring it to man8. but since we only have *.8 man pages at this moment, let's install all of them into "man8" now.

[tchaikov]

we list sphinx-build as one of the build dependencies, and i am not sure we will have a "make dist" for cmake (will cpack do this job?), so i put the generated man pages into the build directory instead of in "/man".

also it might be more natural if we have a CMakeLists.txt in into "/doc/man/8", and collect the man pages there. but i am good either way.

[cbodley]

not sure we will have a "make dist" for cmake

that's my understanding as well. i don't think we want to involve cpack, either

have a CMakeLists.txt in into "/doc/man/8", and collect the man pages there

i would prefer it this way too. for one, it would mean that the entries in manpages_srcs would be relative to their CMAKE_CURRENT_SOURCE_DIR, rather than having to add the ${CMAKE_SOURCE_DIR}/doc/man/ prefix. it also solves the install to "man8" piece because each CMakeLists.txt could do its own install(). but i'm fine with putting this off until we need it

[cbodley]

typo on this line: manpages_srcs -> manpage_srcs

[cbodley]

Thanks for taking this on @tchaikov, you're my hero! The install() part looks correct to me, but in testing 'make install' I'm getting the strangest errors:

-- Installing: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Up-to-date: /home/cbodley/local/share/man/man8
-- Installing: /home/cbodley/local/share/man/man8/ceph_selinux.8
CMake Error at man/cmake_install.cmake:36 (file):
  file INSTALL cannot copy file "/home/cbodley/ceph/man/ceph_selinux.8" to
  "/home/cbodley/local/share/man/man8/ceph_selinux.8".
Call Stack (most recent call first):
  cmake_install.cmake:38 (include)

The resulting directory looks like filesystem corruption:

$ ll ~/local/share/man/man8
ls: cannot access /home/cbodley/local/share/man/man8/ceph-fuse.8: Permission denied
total 0
?????????? ? ? ? ?            ? ceph-fuse.8

..but I was able to reproduce when installing to different devices, and @alimaredia reproduced it on his machine as well.

Digging further, I added some debugging to print the $sphinx_output variable and saw this:
/home/cbodley/ceph/build/doc/man/ceph-fuse.8/;/home/cbodley/ceph/build/doc/man/rbd-fuse.8/;/home/cbodley/ceph/build/doc/man/ceph-rbdnamer.8/;/home/cbodley/ceph/build/doc/man/rbd-nbd.8/;/home/cbodley/ceph/build/doc/man/rbd-replay-prep.8/;/home/cbodley/ceph/build/doc/man/rbd-replay.8/;/home/cbodley/ceph/build/doc/man/rbdmap.8/;/home/cbodley/ceph/build/doc/man/rbd.8/.

So it looks like we need to trim that trailing / off of the section variable that results from string(REGEX MATCH "^[0-9]/" section ${manpage}). There's probably a better way to do that, but adding string(REPLACE "/" "" section ${section}) seemed to work for me and the man pages installed correctly.

[cbodley]

@tchaikov I pushed fixes for the issues I mentioned, feel free to cherry-pick them from https://github.com/cbodley/ceph/commits/wip-cmake-manpages

[tchaikov]

@cbodley and @alimaredia thanks for testing this PR!

i merged your changes and restructured the CMakeLists.txt so we don't need to hardcode the "/doc/man" path.

[tchaikov]

WITH_SELINUX is not supported yet in cmake, will leave it for another PR.

[tchaikov]

added in #9133

[cbodley]

the new stuff in doc/ looks good. retested and everything seemed to work 👍