From c8cbe6db876ae96e8a4e49a11dda8666ba801647 Mon Sep 17 00:00:00 2001 From: Matthew Fernandez Date: Tue, 1 Feb 2022 14:50:45 +1100 Subject: [PATCH] CMake: add comments to 'add_custom_command', 'add_custom_target' steps MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Squashes “[C0113] Missing COMMENT in statement which allows it” `cmake-lint` warnings. --- cmd/dot/CMakeLists.txt | 18 ++++++++++++------ cmd/gvpr/CMakeLists.txt | 6 ++++-- cmd/tools/CMakeLists.txt | 6 ++++-- lib/cdt/CMakeLists.txt | 6 ++++-- lib/cgraph/CMakeLists.txt | 6 ++++-- lib/common/CMakeLists.txt | 4 ++++ lib/expr/CMakeLists.txt | 1 + lib/gvc/CMakeLists.txt | 6 ++++-- lib/pack/CMakeLists.txt | 6 ++++-- lib/pathplan/CMakeLists.txt | 6 ++++-- lib/xdot/CMakeLists.txt | 6 ++++-- 11 files changed, 49 insertions(+), 22 deletions(-) diff --git a/cmd/dot/CMakeLists.txt b/cmd/dot/CMakeLists.txt index d3e88998a..00006fb15 100644 --- a/cmd/dot/CMakeLists.txt +++ b/cmd/dot/CMakeLists.txt @@ -77,33 +77,39 @@ endif() # Specify man pages to be installed if(GZIP) - add_custom_target(man-dot ALL DEPENDS dot.1.gz) + add_custom_target(man-dot ALL DEPENDS dot.1.gz + COMMENT "dot man page") add_custom_command( OUTPUT dot.1.gz COMMAND ${GZIP} -9 --no-name --to-stdout dot.1 >"${CMAKE_CURRENT_BINARY_DIR}/dot.1.gz" MAIN_DEPENDENCY dot.1 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress dot man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/dot.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1) - add_custom_target(man-osage ALL DEPENDS osage.1.gz) + add_custom_target(man-osage ALL DEPENDS osage.1.gz + COMMENT "osage man page") add_custom_command( OUTPUT osage.1.gz COMMAND ${GZIP} -9 --no-name --to-stdout osage.1 >"${CMAKE_CURRENT_BINARY_DIR}/osage.1.gz" MAIN_DEPENDENCY osage.1 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress osage man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/osage.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1) - add_custom_target(man-patchwork ALL DEPENDS patchwork.1.gz) + add_custom_target(man-patchwork ALL DEPENDS patchwork.1.gz + COMMENT "patchwork man page") add_custom_command( OUTPUT patchwork.1.gz COMMAND ${GZIP} -9 --no-name --to-stdout patchwork.1 >"${CMAKE_CURRENT_BINARY_DIR}/patchwork.1.gz" MAIN_DEPENDENCY patchwork.1 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress patchwork man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/patchwork.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1) diff --git a/cmd/gvpr/CMakeLists.txt b/cmd/gvpr/CMakeLists.txt index 1e3fd9f25..d6a1e9a8c 100644 --- a/cmd/gvpr/CMakeLists.txt +++ b/cmd/gvpr/CMakeLists.txt @@ -34,13 +34,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-gvpr ALL DEPENDS gvpr.1.gz) + add_custom_target(man-gvpr ALL DEPENDS gvpr.1.gz + COMMENT "gvpr man page") add_custom_command( OUTPUT gvpr.1.gz COMMAND ${GZIP} -9 --no-name --to-stdout gvpr.1 >"${CMAKE_CURRENT_BINARY_DIR}/gvpr.1.gz" MAIN_DEPENDENCY gvpr.1 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress gvpr man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/gvpr.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1) diff --git a/cmd/tools/CMakeLists.txt b/cmd/tools/CMakeLists.txt index 619b2613c..4432ea02d 100644 --- a/cmd/tools/CMakeLists.txt +++ b/cmd/tools/CMakeLists.txt @@ -13,13 +13,15 @@ function(tool_defaults name) ) if(GZIP) - add_custom_target(man-${name} ALL DEPENDS ${name}.1.gz) + add_custom_target(man-${name} ALL DEPENDS ${name}.1.gz + COMMENT "${name} man page") add_custom_command( OUTPUT ${name}.1.gz COMMAND ${GZIP} -9 --no-name --to-stdout ${name}.1 >"${CMAKE_CURRENT_BINARY_DIR}/${name}.1.gz" MAIN_DEPENDENCY ${name}.1 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress ${name} man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1) diff --git a/lib/cdt/CMakeLists.txt b/lib/cdt/CMakeLists.txt index 5a85c15df..5db9dad01 100644 --- a/lib/cdt/CMakeLists.txt +++ b/lib/cdt/CMakeLists.txt @@ -44,13 +44,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-cdt ALL DEPENDS cdt.3.gz) + add_custom_target(man-cdt ALL DEPENDS cdt.3.gz + COMMENT "cdt man page") add_custom_command( OUTPUT cdt.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout cdt.3 >"${CMAKE_CURRENT_BINARY_DIR}/cdt.3.gz" MAIN_DEPENDENCY cdt.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress cdt man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/cdt.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) diff --git a/lib/cgraph/CMakeLists.txt b/lib/cgraph/CMakeLists.txt index 9e0789214..993a2a848 100644 --- a/lib/cgraph/CMakeLists.txt +++ b/lib/cgraph/CMakeLists.txt @@ -74,13 +74,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-cgraph ALL DEPENDS cgraph.3.gz) + add_custom_target(man-cgraph ALL DEPENDS cgraph.3.gz + COMMENT "cgraph man page") add_custom_command( OUTPUT cgraph.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout cgraph.3 >"${CMAKE_CURRENT_BINARY_DIR}/cgraph.3.gz" MAIN_DEPENDENCY cgraph.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress cgraph man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/cgraph.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) diff --git a/lib/common/CMakeLists.txt b/lib/common/CMakeLists.txt index 5231a78d4..fad0bae9e 100644 --- a/lib/common/CMakeLists.txt +++ b/lib/common/CMakeLists.txt @@ -15,6 +15,7 @@ add_custom_command( COMMAND ${AWK_EXECUTABLE} ${AWK_OPTIONS} -f ${TOP_SOURCE_DIR}/awk/svgcolor.awk ${CMAKE_CURRENT_SOURCE_DIR}/svgcolor_names >${CMAKE_CURRENT_BINARY_DIR}/svgcolor_lib + COMMENT "generate SVG color library" ) add_custom_command( OUTPUT brewer_lib @@ -23,6 +24,7 @@ add_custom_command( COMMAND ${AWK_EXECUTABLE} -f ${TOP_SOURCE_DIR}/awk/brewer.awk ${CMAKE_CURRENT_SOURCE_DIR}/brewer_colors >${CMAKE_CURRENT_BINARY_DIR}/brewer_lib + COMMENT "generate Brewer color library" ) configure_file( "${TOP_SOURCE_DIR}/cmake/generate_color_lib.cmake.in" @@ -36,6 +38,7 @@ add_custom_command( ${CMAKE_CURRENT_SOURCE_DIR}/color_names COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/generate_color_lib.cmake + COMMENT "generate amalgamated color library" ) add_custom_command( OUTPUT common/colortbl.h @@ -45,6 +48,7 @@ add_custom_command( COMMAND ${AWK_EXECUTABLE} -f ${TOP_SOURCE_DIR}/awk/colortbl.awk ${CMAKE_CURRENT_BINARY_DIR}/color_lib >${CMAKE_CURRENT_BINARY_DIR}/common/colortbl.h + COMMENT "generate color table" ) add_library(common_obj OBJECT diff --git a/lib/expr/CMakeLists.txt b/lib/expr/CMakeLists.txt index 0516025b1..ac1b1efbc 100644 --- a/lib/expr/CMakeLists.txt +++ b/lib/expr/CMakeLists.txt @@ -10,6 +10,7 @@ add_custom_command( MAIN_DEPENDENCY y.tab.c COMMAND ${CMAKE_COMMAND} ARGS -P ${CMAKE_CURRENT_SOURCE_DIR}/exparse-replacements.cmake + COMMENT "exparse replacements" ) add_library(expr STATIC diff --git a/lib/gvc/CMakeLists.txt b/lib/gvc/CMakeLists.txt index 2e86364e7..85fbf59e7 100644 --- a/lib/gvc/CMakeLists.txt +++ b/lib/gvc/CMakeLists.txt @@ -107,13 +107,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-gvc ALL DEPENDS gvc.3.gz) + add_custom_target(man-gvc ALL DEPENDS gvc.3.gz + COMMENT "gvc man page") add_custom_command( OUTPUT gvc.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout gvc.3 >"${CMAKE_CURRENT_BINARY_DIR}/gvc.3.gz" MAIN_DEPENDENCY gvc.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress gvc man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/gvc.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) diff --git a/lib/pack/CMakeLists.txt b/lib/pack/CMakeLists.txt index 28fb47866..31f5315e9 100644 --- a/lib/pack/CMakeLists.txt +++ b/lib/pack/CMakeLists.txt @@ -31,13 +31,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-pack ALL DEPENDS pack.3.gz) + add_custom_target(man-pack ALL DEPENDS pack.3.gz + COMMENT "pack man page") add_custom_command( OUTPUT pack.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout pack.3 >"${CMAKE_CURRENT_BINARY_DIR}/pack.3.gz" MAIN_DEPENDENCY pack.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress pack man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/pack.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) diff --git a/lib/pathplan/CMakeLists.txt b/lib/pathplan/CMakeLists.txt index b26f9533a..821ec73b8 100644 --- a/lib/pathplan/CMakeLists.txt +++ b/lib/pathplan/CMakeLists.txt @@ -43,13 +43,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-pathplan ALL DEPENDS pathplan.3.gz) + add_custom_target(man-pathplan ALL DEPENDS pathplan.3.gz + COMMENT "pathplan man page") add_custom_command( OUTPUT pathplan.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout pathplan.3 >"${CMAKE_CURRENT_BINARY_DIR}/pathplan.3.gz" MAIN_DEPENDENCY pathplan.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress pathplan man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/pathplan.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) diff --git a/lib/xdot/CMakeLists.txt b/lib/xdot/CMakeLists.txt index 37f8ce9c2..b327b8e58 100644 --- a/lib/xdot/CMakeLists.txt +++ b/lib/xdot/CMakeLists.txt @@ -29,13 +29,15 @@ install( # Specify man pages to be installed if(GZIP) - add_custom_target(man-xdot ALL DEPENDS xdot.3.gz) + add_custom_target(man-xdot ALL DEPENDS xdot.3.gz + COMMENT "xdot man page") add_custom_command( OUTPUT xdot.3.gz COMMAND ${GZIP} -9 --no-name --to-stdout xdot.3 >"${CMAKE_CURRENT_BINARY_DIR}/xdot.3.gz" MAIN_DEPENDENCY xdot.3 - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "compress xdot man page") install( FILES ${CMAKE_CURRENT_BINARY_DIR}/xdot.3.gz DESTINATION ${MAN_INSTALL_DIR}/man3) -- 2.40.0