CMake: add comments to 'add_custom_command', 'add_custom_target' steps

Squashes “[C0113] Missing COMMENT in statement which allows it” `cmake-lint`
warnings.

diff --git a/cmd/dot/CMakeLists.txt b/cmd/dot/CMakeLists.txt
index d3e88998ab6d6cc67f88a377d239ef035e08c6aa..00006fb1593a48346a3150250f3419d27a164125 100644 (file)
--- 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 1e3fd9f2514d71f00fbce3fc022b65a666813e7e..d6a1e9a8c804b6a00f794a2f112e21a55668e42c 100644 (file)
--- 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 619b2613c4210b12dc0541b7ac462e8a3f5233c1..4432ea02d486a7aee9efd446d3c3d817c1ede57f 100644 (file)
--- 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 5a85c15dfc2d8ddab3cb3a36376ef57ee26471cd..5db9dad0153c806e4c81221f8edfd07da0d95ce7 100644 (file)
--- 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 9e0789214c191123e43688c5644b77186a7a9751..993a2a8488206a5c1b6b10f3df8de6fb478277bf 100644 (file)
--- 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 5231a78d48e9578ed515a7331e58a3d699e27c6b..fad0bae9e7b4b15876d5ffcbcbed43efd5e2dc36 100644 (file)
--- 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 0516025b1d94dc8aff8b8172ef92a01da171fbc8..ac1b1efbc1a3a50cb7e8badbc53718e2140da3a7 100644 (file)
--- 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 2e86364e77c57c02d8726139f9e0aff2ce423a5e..85fbf59e7145f0cda978cef8bcb30528390a6b60 100644 (file)
--- 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 28fb478664ddb243120caff6eee823387f91e497..31f5315e9d5ec065697f343858cc954d6135eb78 100644 (file)
--- 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 b26f9533ab9c5b0120b5a4c3224bde4ef98ea48c..821ec73b8b2edb24da243350e8487c64a1529f07 100644 (file)
--- 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 37f8ce9c2d6be367b445baf91eadbe075abb7084..b327b8e585502dafd006405980c29022dd616459 100644 (file)
--- 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)