summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAllen Winter <allen.winter@kdab.com>2018-01-21 12:46:40 -0500
committerAllen Winter <allen.winter@kdab.com>2018-01-21 12:46:40 -0500
commitfe5b08ef07833ab06d85851cebce5c3607e6b624 (patch)
tree01f371e19d1c2baee8c026d1c7bf2cb8eaba89c0
parentefeb22afa34be79fcc3eba64a598762875353360 (diff)
parentbf9e0b3c7909f316e8b33b12e21ccda6c6d9681f (diff)
downloadlibical-git-fe5b08ef07833ab06d85851cebce5c3607e6b624.tar.gz
Merge branch '3.0'
-rw-r--r--CMakeLists.txt17
-rw-r--r--Install.txt4
-rw-r--r--ReleaseNotes.txt1
-rw-r--r--doc/CMakeLists.txt13
4 files changed, 33 insertions, 2 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 7b64c9af..abc63e6c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -38,6 +38,10 @@
# Requires GObject Introspection development package v0.6.7 or higher
# Default=false (do not generate the introspection files)
#
+# -DICAL_BUILD_DOCS=[true|false]
+# Configure for the API documentation and User Manual. The 'docs' target will not be available.
+# Default=true
+#
# -DICAL_GLIB_VAPI=[true|false]
# Set to build Vala "vapi" files
# Requires Vala package
@@ -319,6 +323,13 @@ if(GOBJECT_INTROSPECTION)
endif()
endif()
+option(ICAL_BUILD_DOCS "Build documentation" True)
+add_feature_info(
+ "Option ICAL_BUILD_DOCS"
+ ICAL_BUILD_DOCS
+ "build API documentation and reference manual"
+)
+
option(ICAL_GLIB_VAPI "Build Vala \"vapi\" files.")
add_feature_info(
"Option ICAL_GLIB_VAPI"
@@ -388,6 +399,7 @@ if(ICAL_GLIB)
"You requested to build libical-glib, but the necessary development packages "
"are missing or too low a version "
"(glib ${MIN_GLIB} and libxml ${MIN_LIBXML} or higher are required)"
+ "Alternatively, disable the libical-glib build (by passing -DICAL_GLIB=False to cmake)"
)
endif()
endif()
@@ -543,7 +555,6 @@ endif()
################# build subdirs ########################
add_subdirectory(design-data)
-add_subdirectory(doc)
add_subdirectory(scripts)
add_subdirectory(test-data)
add_subdirectory(src)
@@ -553,6 +564,10 @@ if(USE_BUILTIN_TZDATA)
add_subdirectory(zoneinfo)
endif()
+if(ICAL_BUILD_DOCS)
+ add_subdirectory(doc) # needs to go last, for the build source files
+endif()
+
########### create and install pkg-config file #########
set(VERSION "${LIBICAL_LIB_VERSION_STRING}")
diff --git a/Install.txt b/Install.txt
index 9b8e0141..1ba87063 100644
--- a/Install.txt
+++ b/Install.txt
@@ -134,3 +134,7 @@ You can override various installation folders by passing the following variables
CMAKE_INSTALL_DATAROOTDIR = The fullpath where to want to put the shared files
for example: cmake -DCMAKE_INSTALL_PREFIX=/opt -DCMAKE_INSTALL_LIBDIR=/opt/lib32 ..
+
+== Build the documentation ==
+Run 'make docs' to build the API documentation and reference.
+Disable the docs make target by running CMake with -DICAL_BUILD_DOCS=False option.
diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 20765435..1e802cb9 100644
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -8,6 +8,7 @@ Version 3.1.0:
Version 3.0.2:
--------------
* No longer attempt to detect the need for -DUSE_32BIT_TIME_T with MSVC
+ * New CMake option ICAL_BUILD_DOCS which can be used to disable the docs target
Version 3.0.1:
--------------
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 596ad989..8f15bd0e 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -22,12 +22,20 @@ if(DOXYGEN_FOUND)
file(GLOB _all_hdrs
${CMAKE_SOURCE_DIR}/src/libical/*.h
${CMAKE_SOURCE_DIR}/src/libical/*.c
+ ${CMAKE_SOURCE_DIR}/src/libical/*.cxx
+ ${CMAKE_BINARY_DIR}/src/libical/*.c
${CMAKE_BINARY_DIR}/src/libical/*.h
+
${CMAKE_SOURCE_DIR}/src/libicalss/*.h
${CMAKE_SOURCE_DIR}/src/libicalss/*.c
+ ${CMAKE_SOURCE_DIR}/src/libicalss/*.cxx
+ ${CMAKE_BINARY_DIR}/src/libicalss/*.c
${CMAKE_BINARY_DIR}/src/libicalss/*.h
+
${CMAKE_SOURCE_DIR}/src/libicalvcal/*.h
${CMAKE_SOURCE_DIR}/src/libicalvcal/*.c
+ ${CMAKE_SOURCE_DIR}/src/libicalvcal/*.cxx
+ ${CMAKE_BINARY_DIR}/src/libicalvcal/*.c
${CMAKE_BINARY_DIR}/src/libicalvcal/*.h
)
list(APPEND _all_hdrs ${_dox_deps})
@@ -48,5 +56,8 @@ if(DOXYGEN_FOUND)
add_custom_target(docs
DEPENDS ${CMAKE_BINARY_DIR}/apidocs/html/index.html
)
-
+ add_dependencies(docs ical icalss icalvcal)
+ if(WITH_CXX_BINDINGS)
+ add_dependencies(docs ical_cxx icalss_cxx)
+ endif()
endif()