# # Copyright 2010-2013 Ettus Research LLC # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # ######################################################################## # List of manual sources ######################################################################## ######################################################################## # Setup Manual ######################################################################## MESSAGE(STATUS "") FIND_PACKAGE(Doxygen) LIBUHD_REGISTER_COMPONENT("Manual" ENABLE_MANUAL ON "DOXYGEN_FOUND" OFF) # TODO conditionally add the manual to Doxygen, now it just adds dependencies IF(ENABLE_MANUAL) FILE(GLOB manual_sources "*.dox") ELSE(ENABLE_MANUAL) SET(manual_source "") ENDIF(ENABLE_MANUAL) ######################################################################## # Setup Doxygen ######################################################################## MESSAGE(STATUS "") LIBUHD_REGISTER_COMPONENT("Doxygen" ENABLE_DOXYGEN ON "DOXYGEN_FOUND" OFF) IF(LIBUHDDEV_PKG) SET(PKG_DOC_DIR share/doc/libuhd-dev) ENDIF(LIBUHDDEV_PKG) IF(ENABLE_DOXYGEN) #generate the doxygen configuration file SET(CMAKE_CURRENT_BINARY_DIR_DOXYGEN ${CMAKE_CURRENT_BINARY_DIR}/doxygen) CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) #make doxygen directory depend on the header files FILE(GLOB_RECURSE header_files ${CMAKE_SOURCE_DIR}/include/*.hpp) ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DEPENDS ${header_files} ${manual_source} COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMENT "Generating documentation with doxygen" ) #make the doxygen generation a built-time dependency ADD_CUSTOM_TARGET(doxygen_docs ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN}) UHD_INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DESTINATION ${PKG_DOC_DIR} COMPONENT doxygen) ENDIF(ENABLE_DOXYGEN) ######################################################################## # List of man page sources ######################################################################## SET(man_page_sources uhd_cal_rx_iq_balance.1 uhd_cal_tx_dc_offset.1 uhd_cal_tx_iq_balance.1 uhd_find_devices.1 uhd_images_downloader.1 uhd_usrp_probe.1 usrp_n2xx_simple_net_burner.1 usrp_x3xx_fpga_burner.1 usrp2_card_burner.1 ) ######################################################################## # Setup man pages ######################################################################## MESSAGE(STATUS "") FIND_PACKAGE(GZip) # No elegant way in CMake to reverse a boolean IF(NOT WIN32) SET(NOT_WIN32 TRUE) ENDIF(NOT WIN32) LIBUHD_REGISTER_COMPONENT("Man Pages" ENABLE_MAN_PAGES ON "GZIP_FOUND;NOT_WIN32" OFF) IF(ENABLE_MAN_PAGES) #Generate man pages FOREACH(manfile ${man_page_sources}) #make the gzip file depend on the text file STRING(REPLACE ".1" "" PROGRAM_NAME "${manfile}") SET(gzfile "${CMAKE_CURRENT_BINARY_DIR}/${manfile}.gz") SET(manfile "${CMAKE_CURRENT_SOURCE_DIR}/${manfile}") ADD_CUSTOM_COMMAND( OUTPUT ${gzfile} DEPENDS ${manfile} COMMAND ${GZIP_EXECUTABLE} -9 -cf ${manfile} > ${gzfile} COMMENT "Generating ${PROGRAM_NAME} man page" ) #make the man page target depend on the gz file LIST(APPEND man_page_gz_files ${gzfile}) UHD_INSTALL(FILES ${gzfile} DESTINATION ${PKG_MAN_DIR} COMPONENT manpages) ENDFOREACH(manfile ${man_page_sources}) #make the man pages a build-time dependency ADD_CUSTOM_TARGET(man_page_gzips ALL DEPENDS ${man_page_gz_files}) ENDIF(ENABLE_MAN_PAGES)