X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=manual%2FCMakeLists.txt;h=3b881a56d6f3e61216742750a3bdcc48feb294fe;hb=ca0a72a2d3d0dc8d469d00bdca5994bf8bb1d740;hp=2cfd263f6185060d574f6f1bf6db48722ddfc30e;hpb=6bbbf1f857f4e1b0de3da37a1a184f27a8ee41c7;p=pulseview.git

diff --git a/manual/CMakeLists.txt b/manual/CMakeLists.txt
index 2cfd263f..3b881a56 100644
--- a/manual/CMakeLists.txt
+++ b/manual/CMakeLists.txt
@@ -17,19 +17,46 @@
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ##
 
+cmake_minimum_required(VERSION 2.8.12)
+
+project(PV_MANUAL)
+
+# External dependencies, required and optional tools.
 find_program(ASCIIDOCTOR_EXECUTABLE NAMES asciidoctor)
 find_program(ASCIIDOCTOR_PDF_EXECUTABLE NAMES asciidoctor-pdf)
 
-set(STYLES_DIR "${CMAKE_CURRENT_SOURCE_DIR}/asciidoctor-stylesheet-factory/stylesheets")
+# Tunables.
+set(STYLES_DIR "asciidoctor-stylesheet-factory/stylesheets")
 set(STYLE_SHEET "readthedocs.css")
-set(MANUAL_SRC "${CMAKE_CURRENT_SOURCE_DIR}/pulseview_manual.txt")
-set(MANUAL_OUT_HTML "${CMAKE_CURRENT_BINARY_DIR}/pulseview_manual.html")
-set(MANUAL_OUT_PDF "${CMAKE_CURRENT_BINARY_DIR}/pulseview_manual.pdf")
 
+# Input files.
+set(MANUAL_SRC "${CMAKE_CURRENT_SOURCE_DIR}/manual.txt")
+
+# Output files, conversion results.
+set(MANUAL_OUT_HTML "${CMAKE_CURRENT_BINARY_DIR}/manual.html")
+set(MANUAL_OUT_PDF "${CMAKE_CURRENT_BINARY_DIR}/manual.pdf")
+
+# Make in-source images/ content available to the output hierarchy for
+# the inspection of created output documents during development in the
+# case of out-of-source build configurations.
+if (NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/images")
+	message(STATUS "creating symlink for manual's images/ subdirectory")
+	execute_process(
+		COMMAND ${CMAKE_COMMAND} -E create_symlink
+			"${CMAKE_CURRENT_SOURCE_DIR}/images"
+			"${CMAKE_CURRENT_BINARY_DIR}/images"
+		RESULT_VARIABLE IMAGES_LINK_RESULT
+	)
+	if (NOT IMAGES_LINK_RESULT EQUAL 0)
+		message(WARNING "manual rendering will lack images")
+	endif ()
+endif ()
+
+# Manual related make(1) targets.
 add_custom_target(manual-html
 	COMMAND ${ASCIIDOCTOR_EXECUTABLE}
 		-a stylesheet=${STYLE_SHEET}
-		-a stylesdir=${STYLES_DIR}
+		-a stylesdir=${CMAKE_CURRENT_SOURCE_DIR}/${STYLES_DIR}
 		-a toc=left
 		--destination-dir=${CMAKE_CURRENT_BINARY_DIR}
 		${MANUAL_SRC}
@@ -42,18 +69,18 @@ if (ASCIIDOCTOR_PDF_EXECUTABLE)
 	add_custom_target(manual-pdf
 		COMMAND ${ASCIIDOCTOR_PDF_EXECUTABLE}
 			-a stylesheet=${STYLE_SHEET}
-			-a stylesdir=${STYLES_DIR}
+			-a stylesdir=${CMAKE_CURRENT_SOURCE_DIR}/${STYLES_DIR}
 			--destination-dir=${CMAKE_CURRENT_BINARY_DIR}
 			${MANUAL_SRC}
 		BYPRODUCTS ${MANUAL_OUT_PDF}
 		DEPENDS ${MANUAL_SRC}
 		WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-		COMMENT "Generating manual, HTML output"
+		COMMENT "Generating manual, PDF output"
 	)
 else ()
 	add_custom_target(manual-pdf
 		COMMAND ${CMAKE_COMMAND} -E echo
-			"asciidoctor-pdf executable is missing, NOT generating HTML output"
+			"asciidoctor-pdf executable is missing, NOT generating PDF output"
 		DEPENDS ${MANUAL_SRC}
 		WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 	)
@@ -61,9 +88,18 @@ endif ()
 add_custom_target(manual)
 add_dependencies(manual manual-html manual-pdf)
 
+set(MANUAL_INST_SUBDIR "share/doc/pulseview")
 install(
 	FILES ${MANUAL_OUT_HTML} ${MANUAL_OUT_PDF}
-	DESTINATION "share/doc/pulseview"
+	DESTINATION ${MANUAL_INST_SUBDIR}
 	PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
 	OPTIONAL
 )
+if (ASCIIDOCTOR_EXECUTABLE)
+	install(
+		DIRECTORY images
+		DESTINATION ${MANUAL_INST_SUBDIR}
+		FILE_PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+		PATTERN "*.xcf" EXCLUDE
+	)
+endif ()