Changed several cmake-based messages to use WARNING instead of STATUS. Changed DOXYGEN_LATEX_OUTPUT to DOXYGEN_PDF_OUTPUT to reflect that the latex is processed into pdf as part of the build process. Flagged the ENABLE_DOXYGEN_PDF_OUTPUT option as Experimental.

This commit is contained in:
Ward Fisher 2014-06-20 17:41:09 -06:00
parent db488b104d
commit f07108ec43
5 changed files with 19 additions and 13 deletions

View File

@ -504,7 +504,7 @@ OPTION(BUILD_UTILITIES "Build ncgen, ncgen3, ncdump." ON)
OPTION(ENABLE_MMAP "Use MMAP." OFF)
IF(ENABLE_MMAP)
IF(NOT HAVE_MREMAP)
MESSAGE(STATUS "mremap not found: disabling MMAP support.")
MESSAGE(WARNING "mremap not found: disabling MMAP support.")
SET(ENABLE_MMAP OFF)
ELSE()
SET(HAVE_MMAP ON)
@ -935,12 +935,12 @@ IF(ENABLE_DOXYGEN)
SET(SHOW_DOXYGEN_TODO_LIST NO CACHE STRING "")
ENDIF(ENABLE_DOXYGEN_TASKS)
OPTION(ENABLE_DOXYGEN_LATEX_OUTPUT "Turn on LaTeX output for Doxygen-generated documentation." OFF)
OPTION(ENABLE_DOXYGEN_PDF_OUTPUT "[EXPERIMENTAL] Turn on PDF output for Doxygen-generated documentation." OFF)
IF(ENABLE_DOXYGEN_LATEX_OUTPUT)
SET(NC_ENABLE_DOXYGEN_LATEX_OUTPUT "YES" CACHE STRING "")
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
SET(NC_ENABLE_DOXYGEN_PDF_OUTPUT "YES" CACHE STRING "")
ELSE()
SET(NC_ENABLE_DOXYGEN_LATEX_OUTPUT "NO" CACHE STRING "")
SET(NC_ENABLE_DOXYGEN_PDF_OUTPUT "NO" CACHE STRING "")
ENDIF()
# Specify whether or not 'dot' was found on the system path.
@ -951,7 +951,7 @@ IF(ENABLE_DOXYGEN)
ENDIF(NC_DOT)
ELSE(DOXYGEN_FOUND)
MESSAGE(STATUS "Unable to build internal documentation. Doxygen does not appear to be on your executable path. Install doxygen and configure the project again.")
MESSAGE(WARNING "Unable to build internal documentation. Doxygen does not appear to be on your executable path. Install doxygen and configure the project again.")
SET(ENABLE_DOXYGEN OFF)
ENDIF(DOXYGEN_FOUND)
ENDIF()

View File

@ -56,12 +56,12 @@ IF(ENABLE_DOXYGEN)
# If ENABLE_DOXYGEN_LATEX_OUTPUT is true, automatically build
# the PDF files.
IF(ENABLE_DOXYGEN_LATEX_OUTPUT)
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
# Process 'main' netcdf documentation.
FIND_PROGRAM(NC_MAKE NAMES make)
FIND_PROGRAM(NC_PDFLATEX NAMES pdflatex)
IF(NOT NC_MAKE OR NOT NC_PDFLATEX)
MESSAGE(STATUS "Unable to locate 'make' or 'pdflatex' program. Unable to build pdf documentation.")
MESSAGE(WARNING "Unable to locate 'make' and/or 'pdflatex' program. Unable to build pdf documentation.")
ELSE()
ADD_CUSTOM_TARGET(doc_all_pdf ALL
make
@ -85,8 +85,14 @@ IF(ENABLE_DOXYGEN)
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/latex_tutorial"
COMMENT "Building NetCDF-Tutorial PDF Documentation" VERBATIM
)
INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/netcdf.pdf"
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-guide.pdf"
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-tutorial.pdf"
DESTINATION "${CMAKE_INSTALL_DOCDIR}/pdf"
COMPONENT documentation)
ENDIF()
ENDIF()
@ -97,8 +103,8 @@ IF(ENABLE_DOXYGEN)
FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/
DESTINATION ${CMAKE_INSTALL_DOCDIR}
INSTALL(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
DESTINATION "${CMAKE_INSTALL_DOCDIR}/html"
COMPONENT documentation)
ENDIF(ENABLE_DOXYGEN)

View File

@ -1570,7 +1570,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_LATEX_OUTPUT@
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_PDF_OUTPUT@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

View File

@ -1608,7 +1608,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_LATEX_OUTPUT@
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_PDF_OUTPUT@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

View File

@ -1581,7 +1581,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_LATEX_OUTPUT@
GENERATE_LATEX = @NC_ENABLE_DOXYGEN_PDF_OUTPUT@
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of