Browse Source

Help: Add note for BundleUtilities usage

The macros defined in BundleUtilities are intended to be used from
an install() rule rather than at configure time. Add a note clarifying
this.
Kyle Edwards 7 years ago
parent
commit
fd28ea35ca
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Modules/BundleUtilities.cmake

+ 4 - 0
Modules/BundleUtilities.cmake

@@ -35,6 +35,10 @@ The following functions are provided by this module:
 Requires CMake 2.6 or greater because it uses function, break and
 PARENT_SCOPE.  Also depends on GetPrerequisites.cmake.
 
+DO NOT USE THESE FUNCTIONS AT CONFIGURE TIME (from ``CMakeLists.txt``)!
+Instead, invoke them from an :command:`install(CODE)` or
+:command:`install(SCRIPT)` rule.
+
 ::
 
   FIXUP_BUNDLE(<app> <libs> <dirs>)