summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-05-12 09:59:36 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-10-15 18:22:20 +0200
commite4799748deb2449b19e3ae95b53b891827ef607e (patch)
tree59e6e8d75ded7b2d9bf001c626a67287d3a85c15
parent1435f4c7f73a51e2a672287424dd0464726a0943 (diff)
Adding comments as documentation for each target.
Change-Id: Ia4d73bd4c2cd3be882998c45fca2fa3da8bae971 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
-rw-r--r--templates/html5/CMakeLists.txt7
-rw-r--r--templates/html5/app/CMakeLists.txt18
-rw-r--r--templates/hybrid-html5/CMakeLists.txt8
-rw-r--r--templates/hybrid-html5/app/CMakeLists.txt20
-rw-r--r--templates/hybrid-html5/binding/CMakeLists.txt41
-rw-r--r--templates/native/CMakeLists.txt8
-rw-r--r--templates/native/app/CMakeLists.txt40
-rw-r--r--templates/service/CMakeLists.txt7
-rw-r--r--templates/service/binding/CMakeLists.txt40
9 files changed, 168 insertions, 21 deletions
diff --git a/templates/html5/CMakeLists.txt b/templates/html5/CMakeLists.txt
index 12a069b..1ddb659 100644
--- a/templates/html5/CMakeLists.txt
+++ b/templates/html5/CMakeLists.txt
@@ -21,8 +21,13 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/config.cmake)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/macros.cmake)
+# Will add each subdirs with a CMakeLists.txt file
project_subdirs_add()
+# Populate each target with LABELS specified.
project_targets_populate()
+# Build package widget once populated.
project_package_build()
-project_closing_msg() \ No newline at end of file
+
+#Display CLOSING_MESSAGE specified in config.cmake file.
+project_closing_msg()
diff --git a/templates/html5/app/CMakeLists.txt b/templates/html5/app/CMakeLists.txt
index b41c0da..ae5f9aa 100644
--- a/templates/html5/app/CMakeLists.txt
+++ b/templates/html5/app/CMakeLists.txt
@@ -16,7 +16,9 @@
# limitations under the License.
###########################################################################
-# Add target to project dependency list
+# Project target list
+# --------------------
+# Add target to project dependency list.
PROJECT_TARGET_ADD(html5-app)
# Define project Targets
@@ -29,7 +31,19 @@ PROJECT_TARGET_ADD(html5-app)
add_custom_target(${TARGET_NAME} ALL DEPENDS dist.prod)
- # Binder exposes a unique public entry point
+ # Targets properties
+ # ------------------
+ # Target properties will be used to build package tree that will be
+ # built using project_package_build.
+ # OUTPUT_NAME: Depends what is the name of your output file, it is
+ # mandatory to specify which is its name with target the property
+ # OUTPUT_NAME for your target. If file name is same of your target then
+ # use variable ${TARGET_NAME}.
+ # LABELS: Choose between "BINDING", "HTDOCS", "EXECUTABLE" depending of
+ # the type of your target.
+ # PREFIX: This prefix will be added on the output file name specify with
+ # OUTPUT_NAME. By default, there isn't PREFIX on target except on
+ # library target with is "lib".
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
LABELS "HTDOCS"
OUTPUT_NAME dist.prod)
diff --git a/templates/hybrid-html5/CMakeLists.txt b/templates/hybrid-html5/CMakeLists.txt
index 822fd7b..1ddb659 100644
--- a/templates/hybrid-html5/CMakeLists.txt
+++ b/templates/hybrid-html5/CMakeLists.txt
@@ -21,9 +21,13 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/config.cmake)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/macros.cmake)
-# Add subdir targets
+# Will add each subdirs with a CMakeLists.txt file
project_subdirs_add()
+# Populate each target with LABELS specified.
project_targets_populate()
+# Build package widget once populated.
project_package_build()
-project_closing_msg() \ No newline at end of file
+
+#Display CLOSING_MESSAGE specified in config.cmake file.
+project_closing_msg()
diff --git a/templates/hybrid-html5/app/CMakeLists.txt b/templates/hybrid-html5/app/CMakeLists.txt
index ec6f6d8..f5ea7f7 100644
--- a/templates/hybrid-html5/app/CMakeLists.txt
+++ b/templates/hybrid-html5/app/CMakeLists.txt
@@ -16,7 +16,11 @@
# limitations under the License.
###########################################################################
-# Add target to project dependency list
+# Project target list
+# --------------------
+# Add target to project dependency list. Name specified as argument will be
+# added to the project target list and the variable ${TARGET_NAME} become
+# available with that value.
PROJECT_TARGET_ADD(hybrid-html5-example)
# Define project Targets
@@ -29,7 +33,19 @@ PROJECT_TARGET_ADD(hybrid-html5-example)
add_custom_target(${TARGET_NAME} ALL DEPENDS dist.prod)
- # Binder exposes a unique public entry point
+ # Targets properties
+ # ------------------
+ # Target properties will be used to build package tree that will be
+ # built using project_package_build.
+ # OUTPUT_NAME: Depends what is the name of your output file, it is
+ # mandatory to specify which is its name with target the property
+ # OUTPUT_NAME for your target. If file name is same of your target then
+ # use variable ${TARGET_NAME}.
+ # LABELS: Choose between "BINDING", "HTDOCS", "EXECUTABLE" depending of
+ # the type of your target.
+ # PREFIX: This prefix will be added on the output file name specify with
+ # OUTPUT_NAME. By default, there isn't PREFIX on target except on
+ # library target with is "lib".
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
LABELS "HTDOCS"
OUTPUT_NAME dist.prod)
diff --git a/templates/hybrid-html5/binding/CMakeLists.txt b/templates/hybrid-html5/binding/CMakeLists.txt
index 6be615f..4d73e8a 100644
--- a/templates/hybrid-html5/binding/CMakeLists.txt
+++ b/templates/hybrid-html5/binding/CMakeLists.txt
@@ -17,16 +17,32 @@
# limitations under the License.
###########################################################################
-# Add target to project dependency list
+# Project target list
+# --------------------
+# Add target to project dependency list. Name specified as argument will be
+# added to the project target list and the variable ${TARGET_NAME} become
+# available with that value.
PROJECT_TARGET_ADD(xxx)
# Define project Targets
- add_library(${TARGET_NAME} MODULE
+ add_library(${TARGET_NAME} MODULE
${TARGET_NAME}-hat.c
${TARGET_NAME}-cb.c
)
- # Binder exposes a unique public entry point
+ # Targets properties
+ # ------------------
+ # Target properties will be used to build package tree that will be
+ # built using project_package_build.
+ # OUTPUT_NAME: Depends what is the name of your output file, it is
+ # mandatory to specify which is its name with target the property
+ # OUTPUT_NAME for your target. If file name is same of your target then
+ # use variable ${TARGET_NAME}.
+ # LABELS: Choose between "BINDING", "HTDOCS", "EXECUTABLE" depending of
+ # the type of your target.
+ # PREFIX: This prefix will be added on the output file name specify with
+ # OUTPUT_NAME. By default, there isn't PREFIX on target except on
+ # library target with is "lib".
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
PREFIX "afb-"
LABELS "BINDING"
@@ -34,10 +50,27 @@ PROJECT_TARGET_ADD(xxx)
OUTPUT_NAME ${TARGET_NAME}
)
- # Library dependencies (include updates automatically)
+ # Link
+ # ----
+ # Library dependencies (include updates automatically). Linked to the
+ # target.
TARGET_LINK_LIBRARIES(${TARGET_NAME}
${link_libraries})
+ # Include
+ # -------
+ # Define target includes search and dependencies. Choose between PUBLIC,
+ # PRIVATE or INTERFACE. PRIVATE and PUBLIC items will populate the
+ # INCLUDE_DIRECTORIES property of <target>. PUBLIC and INTERFACE items
+ # will populate the INTERFACE_INCLUDE_DIRECTORIES property of <target>.
+ # The following arguments specify include directories.
+ # INTERFACE_INCLUDE_DIRECTORIES will be read at the
+ # TARGET_LINK_LIBRARIES step for others targets that link against this
+ # target.
+ TARGET_INCLUDE_DIRECTORIES( ${TARGET_NAME}
+ PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}
+ )
+
# installation directory
INSTALL(TARGETS ${TARGET_NAME}
LIBRARY DESTINATION ${BINDINGS_INSTALL_DIR})
diff --git a/templates/native/CMakeLists.txt b/templates/native/CMakeLists.txt
index 822fd7b..1ddb659 100644
--- a/templates/native/CMakeLists.txt
+++ b/templates/native/CMakeLists.txt
@@ -21,9 +21,13 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/config.cmake)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/macros.cmake)
-# Add subdir targets
+# Will add each subdirs with a CMakeLists.txt file
project_subdirs_add()
+# Populate each target with LABELS specified.
project_targets_populate()
+# Build package widget once populated.
project_package_build()
-project_closing_msg() \ No newline at end of file
+
+#Display CLOSING_MESSAGE specified in config.cmake file.
+project_closing_msg()
diff --git a/templates/native/app/CMakeLists.txt b/templates/native/app/CMakeLists.txt
index 5a9fa63..1e558fd 100644
--- a/templates/native/app/CMakeLists.txt
+++ b/templates/native/app/CMakeLists.txt
@@ -17,14 +17,22 @@
# limitations under the License.
###########################################################################
-# Add target to project dependency list
+# Project target list
+# --------------------
+# Add target to project dependency list. Name specified as argument will be
+# added to the project target list and the variable ${TARGET_NAME} become
+# available with that value.
PROJECT_TARGET_ADD(xxx-native-app)
# Define project Targets
- add_executable(${TARGET_NAME}
+ add_executable(${TARGET_NAME}
${TARGET_NAME}.c
)
+ # Link
+ # ----
+ # Library dependencies (include updates automatically). Linked to the
+ # target.
link_libraries(
${CMAKE_THREAD_LIBS_INIT}
${libafbwsc_LIBRARIES}
@@ -32,16 +40,42 @@ PROJECT_TARGET_ADD(xxx-native-app)
${libsystemd_LIBRARIES}
)
- # Binder exposes a unique public entry point
+ # Targets properties
+ # ------------------
+ # Target properties will be used to build package tree that will be
+ # built using project_package_build.
+ # OUTPUT_NAME: Depends what is the name of your output file, it is
+ # mandatory to specify which is its name with target the property
+ # OUTPUT_NAME for your target. If file name is same of your target then
+ # use variable ${TARGET_NAME}.
+ # LABELS: Choose between "BINDING", "HTDOCS", "EXECUTABLE" depending of
+ # the type of your target.
+ # PREFIX: This prefix will be added on the output file name specify with
+ # OUTPUT_NAME. By default, there isn't PREFIX on target except on
+ # library target with is "lib".
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
LABELS "EXECUTABLE"
OUTPUT_NAME ${TARGET_NAME})
+ # Include
+ # -------
+ # Define target includes search and dependencies. Choose between PUBLIC,
+ # PRIVATE or INTERFACE. PRIVATE and PUBLIC items will populate the
+ # INCLUDE_DIRECTORIES property of <target>. PUBLIC and INTERFACE items
+ # will populate the INTERFACE_INCLUDE_DIRECTORIES property of <target>.
+ # The following arguments specify include directories.
+ # INTERFACE_INCLUDE_DIRECTORIES will be read at the
+ # TARGET_LINK_LIBRARIES step for others targets that link against this
+ # target.
TARGET_INCLUDE_DIRECTORIES(${TARGET_NAME}
PUBLIC ${libafbwsc_INCLUDE_DIRS}
${json-c_INCLUDE_DIRS}
${libsystemd_INCLUDE_DIRS})
+ # Link
+ # ----
+ # Library dependencies (include updates automatically). Linked to the
+ # target.
TARGET_LINK_LIBRARIES(${TARGET_NAME}
afbwsc
${link_libraries})
diff --git a/templates/service/CMakeLists.txt b/templates/service/CMakeLists.txt
index 12a069b..1ddb659 100644
--- a/templates/service/CMakeLists.txt
+++ b/templates/service/CMakeLists.txt
@@ -21,8 +21,13 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/config.cmake)
include(${CMAKE_CURRENT_SOURCE_DIR}/etc/macros.cmake)
+# Will add each subdirs with a CMakeLists.txt file
project_subdirs_add()
+# Populate each target with LABELS specified.
project_targets_populate()
+# Build package widget once populated.
project_package_build()
-project_closing_msg() \ No newline at end of file
+
+#Display CLOSING_MESSAGE specified in config.cmake file.
+project_closing_msg()
diff --git a/templates/service/binding/CMakeLists.txt b/templates/service/binding/CMakeLists.txt
index bd422b5..0d08b90 100644
--- a/templates/service/binding/CMakeLists.txt
+++ b/templates/service/binding/CMakeLists.txt
@@ -16,7 +16,11 @@
# limitations under the License.
###########################################################################
-# Add target to project dependency list
+# Project target list
+# --------------------
+# Add target to project dependency list. Name specified as argument will be
+# added to the project target list and the variable ${TARGET_NAME} become
+# available with that value.
PROJECT_TARGET_ADD(xxx-service)
# Define project Targets
@@ -25,13 +29,41 @@ PROJECT_TARGET_ADD(xxx-service)
${TARGET_NAME}-cb.c
)
- # Binder exposes a unique public entry point
+ # Targets properties
+ # ------------------
+ # Target properties will be used to build package tree that will be
+ # built using project_package_build.
+ # OUTPUT_NAME: Depends what is the name of your output file, it is
+ # mandatory to specify which is its name with target the property
+ # OUTPUT_NAME for your target. If file name is same of your target then
+ # use variable ${TARGET_NAME}.
+ # LABELS: Choose between "BINDING", "HTDOCS", "EXECUTABLE" depending of
+ # the type of your target.
+ # PREFIX: This prefix will be added on the output file name specify with
+ # OUTPUT_NAME. By default, there isn't PREFIX on target except on
+ # library target with is "lib".
SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
PREFIX "afs-"
LABELS "BINDING"
LINK_FLAGS ${BINDINGS_LINK_FLAG}
OUTPUT_NAME ${TARGET_NAME})
- # Library dependencies (include updates automatically)
+ # Link
+ # ----
+ # Library dependencies (include updates automatically). Linked to the
+ # target.
TARGET_LINK_LIBRARIES(${TARGET_NAME}
- ${link_libraries}) \ No newline at end of file
+ ${link_libraries})
+
+ # Include
+ # -------
+ # Define target includes search and dependencies. Choose between PUBLIC,
+ # PRIVATE or INTERFACE. PRIVATE and PUBLIC items will populate the
+ # INCLUDE_DIRECTORIES property of <target>. PUBLIC and INTERFACE items
+ # will populate the INTERFACE_INCLUDE_DIRECTORIES property of <target>.
+ # The following arguments specify include directories.
+ # INTERFACE_INCLUDE_DIRECTORIES will be read at the
+ # TARGET_LINK_LIBRARIES step for others targets that link against this
+ TARGET_INCLUDE_DIRECTORIES(${TARGET_NAME}
+ PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+