From b647cd8f89dfe5edc344399c24918f02ea409f76 Mon Sep 17 00:00:00 2001 From: Chris White Date: Wed, 4 Sep 2024 16:34:53 -0700 Subject: [PATCH] add notes about future deprecation --- cmake/BLTInstallableMacros.cmake | 5 +++++ docs/api/utility.rst | 8 ++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/cmake/BLTInstallableMacros.cmake b/cmake/BLTInstallableMacros.cmake index ff314ab0a..faa5d5bf4 100644 --- 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 index a0f1c1bff..bbce313cc 100644 --- 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**