X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2FCMakeLists.txt;h=55c50985f827f5b5e10c209b4f7e27071e52b3b1;hb=0b79fc264eea2591ad6f645d0c90cc378ea5603b;hp=44f0001b0540820f6b8cbea2d6082dab3a775da9;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 44f0001..55c5098 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,7 +1,7 @@ # #================================================================================== -# Copyright (c) 2019 Nokia +# Copyright (c) 2019 Nokia # Copyright (c) 2018-2019 AT&T Intellectual Property. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -39,7 +39,7 @@ if( BUILD_DOC ) if( NOT EXISTS ${tfm} ) # not yet built here, pull and build # pull and build {X}fm tools needed to generate manpages - execute_process( + execute_process( COMMAND "bash" "-c" "git clone https://github.com/ScottDaniels/xfm.git && cd xfm && mkdir .build && cd .build && cmake .. && make" WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} ) @@ -47,7 +47,7 @@ if( BUILD_DOC ) else() message( "+++ found xfm in the build environment" ) endif() - + endif() # base filenames (with .xfm are input) @@ -62,6 +62,7 @@ if( BUILD_DOC ) rmr_wh_close.3 rmr_alloc_msg.3 rmr_get_rcvfd.3 + rmr_get_meid.3 rmr_rcv_msg.3 rmr_send_msg.3 rmr_wh_open.3 @@ -73,38 +74,62 @@ if( BUILD_DOC ) rmr_support.3 rmr_torcv_msg.3 rmr_wh_send_msg.3 + rmr_get_trace.3 + rmr_init_trace.3 + rmr_set_trace.3 + rmr_tralloc_msg.3 + rmr_get_trlen.3 + rmr_get_src.3 + rmr_mt_call.3 + rmr_mt_rcv.3 + rmr_get_srcip.3 + rmr_realloc_payload.3 + rmr_trace_ref.3 + rmr_set_stimeout.3 + rmr_get_xact.3 ) - # empty list of roff/troff input files we generated + # initialise lists of files we generated set( man3_files ) set( man7_files ) - # mk is so much easier than this -- grumble # for each source, build a specific command that runs tfm to generate the - # troff output. Sed is needed to remove the leading blank that tfm likes - # to insert even if indention is 0. + # troff output as a gzipped file. Sed is needed to remove the leading blank + # that tfm likes to insert even if indention is 0. We also generate postscript + # markdown, plain ascii and rts output which are left in the build directory + # for the developer to use as needed. # foreach( nm IN LISTS man_names ) set( out ${CMAKE_BINARY_DIR}/${nm} ) set( in ${CMAKE_SOURCE_DIR}/doc/src/man/${nm}.xfm ) - add_custom_command( - OUTPUT ${out} + add_custom_command( + OUTPUT ${out}.gz DEPENDS ${in} - COMMAND bash -c "export LIB=${CMAKE_SOURCE_DIR}/doc/src; ${tfm} ${in} stdout | sed 's/^ //' >${out}; ${pfm} ${in} ${out}.ps" + COMMAND bash -c "export LIB=${CMAKE_SOURCE_DIR}/doc/src; \ + export OUTPUT_TYPE=troff; \ + ${tfm} ${in} stdout | sed 's/^ //' | gzip >${out}.gz; \ + export OUTPUT_TYPE=rst; \ + ${tfm} ${in} ${out}.rst; \ + export OUTPUT_TYPE=txt; \ + ${tfm} ${in} ${out}.txt; \ + export OUTPUT_TYPE=markdown; \ + ${tfm} ${in} stdout | sed 's/^ //' >${out}.md; \ + export OUTPUT_TYPE=postscript; \ + ${pfm} ${in} ${out}.ps" WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMENT "Building manpage ${out}" VERBATIM ) if( ${out} MATCHES ".*\.3" ) - list( APPEND man3_files ${out} ) + list( APPEND man3_files ${out}.gz ) else() - list( APPEND man7_files ${out} ) + list( APPEND man7_files ${out}.gz ) endif() endforeach() # we must force these to install - # find all of the man pages in build and add them to the deb + # find all of the man pages in build and add them to the package # install( FILES ${man3_files} DESTINATION ${install_man}/man3/ ) install( FILES ${man7_files} DESTINATION ${install_man}/man7/ ) @@ -112,6 +137,6 @@ if( BUILD_DOC ) add_custom_target( man_pages ALL DEPENDS ${man3_files};${man7_files} ) else() - message( "+++ not building doc, set -DBULID_DOC on cmake commandline to enable" ) + message( "+++ not building doc, set -DBULID_DOC=1 on cmake command line to enable" ) endif() unset( BUILD_DOC CACHE ) # prevent it from being applied next build unless specifically set on comd line