X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=manual%2FCMakeLists.txt;h=f336a02dadc29da80096f27dea50c1268dbc3ecc;hp=25a26e995a22b050ec70893fde49cf8660f9fbd6;hb=HEAD;hpb=e6bc4b9da448820743ade916fec1411a78e2c169

diff --git a/manual/CMakeLists.txt b/manual/CMakeLists.txt
index 25a26e99..3b881a56 100644
--- a/manual/CMakeLists.txt
+++ b/manual/CMakeLists.txt
@@ -17,15 +17,42 @@
 ## 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)
 
+# 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}
@@ -48,12 +75,12 @@ if (ASCIIDOCTOR_PDF_EXECUTABLE)
 		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}
 	)