doc/CMakeLists.txt

   1
   2 #
   3 #==================================================================================
   4 #       Copyright (c) 2019 Nokia
   5 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
   6 #
   7 #   Licensed under the Apache License, Version 2.0 (the "License");
   8 #   you may not use this file except in compliance with the License.
   9 #   You may obtain a copy of the License at
  10 #
  11 #       http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 #   Unless required by applicable law or agreed to in writing, software
  14 #   distributed under the License is distributed on an "AS IS" BASIS,
  15 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 #   See the License for the specific language governing permissions and
  17 #   limitations under the License.
  18 #==================================================================================
  19 #
  20
  21
  22 # builds the man pages for the deb file (generates troff from {X}fm).
  23 # also builds postscript files, but leaves them in the current build dir.
  24 # but, ONLY if build_doc variable is true
  25 #
  26
  27 # look for tfm to build the man pages with. if not found, then we pull
  28 # and build in the current build environment setting tfm/pfm commands to
  29 # point at the correct spot.  If the user has {X}fm installed, we just
  30 # use their install.
  31 #
  32 if( BUILD_DOC )
  33         find_program( tfm NAMES tfm )
  34         find_program( pfm NAMES pfm )
  35
  36         if( "${tfm}" MATCHES "tfm-NOTFOUND" )           # user doesn't have installed; set where we expect them
  37                 set( tfm ${CMAKE_CURRENT_BINARY_DIR}/xfm/.build/src/tfm/tfm )
  38                 set( pfm "${CMAKE_CURRENT_BINARY_DIR}/xfm/.build/src/pfm/pfm" )
  39
  40                 if( NOT EXISTS ${tfm} )                                 # not yet built here, pull and build
  41                         # pull and build {X}fm tools needed to generate manpages
  42                         execute_process(
  43                                 COMMAND "bash" "-c" "git clone https://github.com/ScottDaniels/xfm.git && cd xfm && mkdir .build && cd .build && cmake .. && make"
  44                                 WORKING_DIRECTORY  ${CMAKE_CURRENT_BINARY_DIR}
  45                         )
  46                         message( "+++ xfm  pulled and built" )
  47                 else()
  48                         message( "+++ found xfm in the build environment" )
  49                 endif()
  50
  51         endif()
  52
  53         # base filenames (with .xfm are input)
  54         set( man_names
  55                 rmr.7
  56                 rmr_bytes2meid.3
  57                 rmr_bytes2xact.3
  58                 rmr_bytes2payload.3
  59                 rmr_free_msg.3
  60                 rmr_payload_size.3
  61                 rmr_rts_msg.3
  62                 rmr_wh_close.3
  63                 rmr_alloc_msg.3
  64                 rmr_get_rcvfd.3
  65                 rmr_get_meid.3
  66                 rmr_rcv_msg.3
  67                 rmr_send_msg.3
  68                 rmr_wh_open.3
  69                 rmr_call.3
  70                 rmr_init.3
  71                 rmr_ready.3
  72                 rmr_str2meid.3
  73                 rmr_str2xact.3
  74                 rmr_support.3
  75                 rmr_torcv_msg.3
  76                 rmr_wh_send_msg.3
  77                 rmr_get_trace.3
  78                 rmr_init_trace.3
  79                 rmr_set_trace.3
  80                 rmr_set_vlevel.3
  81                 rmr_tralloc_msg.3
  82                 rmr_get_trlen.3
  83                 rmr_get_src.3
  84                 rmr_mt_call.3
  85                 rmr_mt_rcv.3
  86                 rmr_get_srcip.3
  87                 rmr_realloc_payload.3
  88                 rmr_trace_ref.3
  89                 rmr_set_stimeout.3
  90                 rmr_get_xact.3
  91                 rmr_wh_state.3
  92                 rmr_wh_call.3
  93         )
  94
  95         # initialise lists of files we generated
  96         set( man3_files )
  97         set( man7_files )
  98
  99         # for each source, build a specific command that runs tfm to generate the
 100         # troff output as a gzipped file. Sed is needed to remove the leading blank
 101         # that tfm likes to insert even if indention is 0. We also generate postscript
 102         # markdown, plain ascii and rts output which are left in the build directory
 103         # for the developer to use as needed.
 104         #
 105         foreach( nm IN LISTS man_names )
 106           set( out ${CMAKE_BINARY_DIR}/${nm} )
 107           set( in ${CMAKE_SOURCE_DIR}/doc/src/man/${nm}.xfm )
 108
 109           add_custom_command(
 110                         OUTPUT ${out}.gz
 111                         DEPENDS ${in}
 112                         COMMAND bash -c "export LIB=${CMAKE_SOURCE_DIR}/doc/src; \
 113                                 export OUTPUT_TYPE=troff; \
 114                                         ${tfm} ${in} stdout | sed 's/^ //' | gzip >${out}.gz; \
 115                                 export OUTPUT_TYPE=rst; \
 116                                         ${tfm} ${in} ${out}.rst; \
 117                                 export OUTPUT_TYPE=txt; \
 118                                   ${tfm} ${in} ${out}.txt; \
 119                                 export OUTPUT_TYPE=markdown; \
 120                                         ${tfm} ${in} stdout | sed 's/^ //' >${out}.md; \
 121                                 export OUTPUT_TYPE=postscript; \
 122                                         ${pfm} ${in} ${out}.ps"
 123                         WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 124                         COMMENT "Building manpage ${out}"
 125                         VERBATIM
 126                 )
 127                 if( ${out} MATCHES ".*\.3" )
 128                         list( APPEND man3_files ${out}.gz )
 129                 else()
 130                         list( APPEND man7_files ${out}.gz )
 131                 endif()
 132         endforeach()
 133
 134         # we must force these to install
 135         # find all of the man pages in build and add them to the package
 136         #
 137         install( FILES ${man3_files} DESTINATION ${install_man}/man3/ )
 138         install( FILES ${man7_files} DESTINATION ${install_man}/man7/ )
 139
 140         add_custom_target( man_pages ALL DEPENDS ${man3_files};${man7_files} )
 141
 142 else()
 143         message( "+++ not building doc, set -DBULID_DOC=1 on cmake command line to enable" )
 144 endif()
 145 unset( BUILD_DOC  CACHE )    # prevent it from being applied next build unless specifically set on comd line