manual: cosmetic nits, add comments to CMake rules

[pulseview.git] / manual / CMakeLists.txt

diff --git a/manual/CMakeLists.txt b/manual/CMakeLists.txt
index 2cfd263f6185060d574f6f1bf6db48722ddfc30e..17bf487aa5a99a6374685270335d5f300f66dbac 100644 (file)
--- a/manual/CMakeLists.txt
+++ b/manual/CMakeLists.txt
@@ -17,19 +17,26 @@
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ##
 
+# 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")
+
+# Input files.
 set(MANUAL_SRC "${CMAKE_CURRENT_SOURCE_DIR}/pulseview_manual.txt")
+
+# Output files, conversion results.
 set(MANUAL_OUT_HTML "${CMAKE_CURRENT_BINARY_DIR}/pulseview_manual.html")
 set(MANUAL_OUT_PDF "${CMAKE_CURRENT_BINARY_DIR}/pulseview_manual.pdf")
 
+# 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,7 +49,7 @@ 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}
@@ -61,9 +68,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 ()