From 5810a67af9310f83ae8241f7d5b58e26a262360d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Risto=20Peja=C5=A1inovi=C4=87?=
 <risto.pejasinovic@gmail.com>
Date: Sun, 15 Sep 2024 12:30:55 +0200
Subject: [PATCH] Add DESCRIPTION field to add_ip()

---
 cmake/hwip.cmake                      |  9 +++++++-
 tests/add_ip/add_ip_description.cmake | 31 +++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 1 deletion(-)
 create mode 100644 tests/add_ip/add_ip_description.cmake

diff --git a/cmake/hwip.cmake b/cmake/hwip.cmake
index d89a050..1783645 100644
--- a/cmake/hwip.cmake
+++ b/cmake/hwip.cmake
@@ -21,9 +21,10 @@ include("${CMAKE_CURRENT_LIST_DIR}/utils/safe_get_target_property.cmake")
 #     VENDOR vendor
 #     LIBRARY lib
 #     VERSION 1.2.3
+#     DESCRIPTION "This is a sample IP"
 #     )
 # ```
-# In full form it is possible to ommit VENDOR, LIBRARY and VERSION, although it is not recommended.
+# In full form it is possible to ommit VENDOR, LIBRARY and VERSION, DESCRIPTION, although it is not recommended.
 #
 # Ommiting them all would have following signature:
 # ```
@@ -47,6 +48,8 @@ include("${CMAKE_CURRENT_LIST_DIR}/utils/safe_get_target_property.cmake")
 # :type LIBRARY: string
 # :keyword VERSION: Version of the IP following a three-part version number (Major.Minor.Patch, e.g., 1.0.13).
 # :type VERSION: string
+# :keyword DESCRIPTION: Short description to be associated with the IP library, will appear in `help_ips()` message
+# :type DESCRIPTION: string
 #]]
 function(add_ip IP_NAME)
     cmake_parse_arguments(ARG "" "VENDOR;LIBRARY;VERSION;DESCRIPTION" "" ${ARGN})
@@ -94,6 +97,10 @@ function(add_ip IP_NAME)
         endif()
     endif()
 
+    if(ARG_DESCRIPTION)
+        set_property(TARGET ${IP_LIB} PROPERTY DESCRIPTION ${ARG_DESCRIPTION})
+    endif()
+
     # Unset the parent variables that might have been set by previous add_ip() call
     unset(IP_VENDOR PARENT_SCOPE)
     unset(IP_LIBRARY PARENT_SCOPE)
diff --git a/tests/add_ip/add_ip_description.cmake b/tests/add_ip/add_ip_description.cmake
new file mode 100644
index 0000000..36bcd76
--- /dev/null
+++ b/tests/add_ip/add_ip_description.cmake
@@ -0,0 +1,31 @@
+include("${CMAKE_CURRENT_LIST_DIR}/../../CMakeLists.txt")
+
+set(TEST_NAME add_ip_description)
+
+ct_add_test(NAME ${TEST_NAME})
+function(${${TEST_NAME}})
+    add_ip(ip
+        VENDOR vendor
+        LIBRARY lib
+        VERSION 1.2.3
+        DESCRIPTION "Simple description"
+        )
+    ct_assert_target_has_property(${IP} DESCRIPTION)
+    get_target_property(_desc ${IP} DESCRIPTION)
+    ct_assert_equal(_desc "Simple description")
+
+    add_ip(ip2
+        DESCRIPTION "Simpler description"
+        )
+    ct_assert_target_has_property(${IP} DESCRIPTION)
+    get_target_property(_desc ${IP} DESCRIPTION)
+    ct_assert_equal(_desc "Simpler description")
+
+    add_ip(vendor2::lib::ip::0.0.1
+        DESCRIPTION "Even simpler description"
+        )
+    ct_assert_target_has_property(${IP} DESCRIPTION)
+    get_target_property(_desc ${IP} DESCRIPTION)
+    ct_assert_equal(_desc "Even simpler description")
+
+endfunction()