add notes about future deprecation

LLNL · Sep 4, 2024 · b647cd8 · b647cd8
1 parent cf9628b
commit b647cd8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/cmake/BLTInstallableMacros.cmake b/cmake/BLTInstallableMacros.cmake
@@ -496,6 +496,11 @@ endmacro(blt_find_target_dependencies)
 ##                                [QUIET])
 ##
 ## Converts existing interface includes to system interface includes.
+##
+## Note: The argument ``TARGET`` will be deprecated in the near future. Until then,
+## if both ``TARGET`` and ``TARGETS`` is given, all given target include
+## directories will be converted.
+##
 ##------------------------------------------------------------------------------
 function(blt_convert_to_system_includes)
     set(options QUIET)

diff --git a/docs/api/utility.rst b/docs/api/utility.rst
@@ -243,8 +243,12 @@ blt_convert_to_system_includes
 Converts existing interface includes to system interface includes.
 Warns if a target does not exist unless ``QUIET`` is specified.
 Recurses through link libraries and interface link libraries if
-``CHILDREN TRUE`` is specified. If both ``TARGET`` and ``TARGETS``
-is given, all given target include directories will be converted.
+``CHILDREN TRUE`` is specified.
+
+.. note::
+  The argument ``TARGET`` will be deprecated in the near future. Until then,
+  if both ``TARGET`` and ``TARGETS`` is given, all given target include
+  directories will be converted.
 
 .. code-block:: cmake
    :caption: **Example**