Commit 4fafb349 authored by Lynn Garren's avatar Lynn Garren
Browse files

replace -Dbuild_docs:BOOL=ON with -DCLHEP_BUILD_DOCS=ON, thanks to Ben Morgan

parent cc0b0163
......@@ -2,7 +2,7 @@
# Top Level CMakeLists.txt for CLHEP
# cmake [-DCMAKE_INSTALL_PREFIX=/install/path]
# [-DCMAKE_BUILD_TYPE=Debug|Release|RelWithDebInfo|MinSizeRel]
# [-Dbuild_docs:BOOL=ON]
# [-DCLHEP_BUILD_DOCS=ON]
# /path/to/source
# make
# make test
......@@ -22,12 +22,14 @@ set(CMAKE_MODULE_PATH "${CMAKE_ROOT}/Modules")
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules ${CMAKE_MODULE_PATH})
message(STATUS "module path is ${CMAKE_MODULE_PATH}" )
# build_docs is OFF (false) by default
if ( build_docs )
message(STATUS "documents WILL be built and installed" )
else()
message(STATUS "documents WILL NOT be installed" )
# CLHEP_BUILD_DOCS is OFF (false) by default
option(CLHEP_BUILD_DOCS "Build and install CLHEP documentation" OFF)
if(CLHEP_BUILD_DOCS)
# backwards compatibility variable
set(build_docs ON)
message(STATUS "Enabled build and install of documents")
endif()
# various handy macros
include(ClhepOutOfSourceBuild)
include(ClhepCopyHeaders)
......
......@@ -10,7 +10,7 @@ clhep_package_config()
add_subdirectory(Exceptions)
add_subdirectory(src)
add_subdirectory(test)
if ( build_docs )
if ( CLHEP_BUILD_DOCS )
message(STATUS "building documents for ${PACKAGE}" )
add_subdirectory(doc)
endif()
......@@ -8,7 +8,7 @@ clhep_package_config()
add_subdirectory(GenericFunctions)
add_subdirectory(src)
add_subdirectory(test)
if ( build_docs )
if ( CLHEP_BUILD_DOCS )
message(STATUS "building documents for ${PACKAGE}" )
add_subdirectory(doc)
endif()
......@@ -8,7 +8,7 @@ clhep_package_config()
add_subdirectory(Random)
add_subdirectory(src)
add_subdirectory(test)
if ( build_docs )
if ( CLHEP_BUILD_DOCS )
message(STATUS "building documents for ${PACKAGE}" )
add_subdirectory(doc)
endif()
......@@ -15,7 +15,7 @@ install ( FILES ${CLHEP_BINARY_DIR}/Units/Units-config
add_subdirectory(Units)
add_subdirectory(test)
if ( build_docs )
if ( CLHEP_BUILD_DOCS )
message(STATUS "building documents for ${PACKAGE}" )
add_subdirectory(doc)
endif()
......@@ -8,7 +8,7 @@ clhep_package_config()
add_subdirectory(Vector)
add_subdirectory(src)
add_subdirectory(test)
if ( build_docs )
if ( CLHEP_BUILD_DOCS )
message(STATUS "building documents for ${PACKAGE}" )
add_subdirectory(doc)
endif()
......@@ -50,10 +50,9 @@ make install
# cmake options
#-------------------------------------------------------------
-DCMAKE_INSTALL_PREFIX=/install/path
-DCMAKE_BUILD_TYPE=Debug|Release|RelWithDebInfo|MinSizeRel
-Dbuild_docs:BOOL=ON
-DCLHEP_BUILD_DOCS=ON
#-------------------------------------------------------------
# building documents
......@@ -61,7 +60,7 @@ make install
Documents are not built or installed automatically.
If you wish to build and install the documents,
add -Dbuild_docs:BOOL=ON to your cmake command.
add -DCLHEP_BUILD_DOCS=ON to your cmake command.
Documents will then be built during the normal build.
You will need to have latex in your path.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment