diff options
author | Alexander Neundorf <neundorf@kde.org> | 2008-08-14 22:13:31 +0000 |
---|---|---|
committer | Alexander Neundorf <neundorf@kde.org> | 2008-08-14 22:13:31 +0000 |
commit | 605c7c4a491fa6014e005d00e6a1d02a63aa2d51 (patch) | |
tree | e748b9cdf92d6a62afec7120722912a8757d7d88 | |
parent | bd92489875467b8bc671100678b7dda86e2374ee (diff) | |
download | extra-cmake-modules-605c7c4a491fa6014e005d00e6a1d02a63aa2d51.tar.gz extra-cmake-modules-605c7c4a491fa6014e005d00e6a1d02a63aa2d51.tar.bz2 |
-add some documentation
Alex
svn path=/trunk/KDE/kdelibs/; revision=847189
-rw-r--r-- | modules/MacroEnsureOutOfSourceBuild.cmake | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/modules/MacroEnsureOutOfSourceBuild.cmake b/modules/MacroEnsureOutOfSourceBuild.cmake index ef4d525f..cb26e0c3 100644 --- a/modules/MacroEnsureOutOfSourceBuild.cmake +++ b/modules/MacroEnsureOutOfSourceBuild.cmake @@ -1,5 +1,9 @@ # - MACRO_ENSURE_OUT_OF_SOURCE_BUILD(<errorMessage>) # MACRO_ENSURE_OUT_OF_SOURCE_BUILD(<errorMessage>) +# Call this macro in your project if you want to enforce out-of-source builds. +# If an in-source build is detected, it will abort with the given error message. +# This macro works in any of the CMakeLists.txt of your project, but the recommended +# location to call this is close to the beginning of the top level CMakeLists.txt # Copyright (c) 2006, Alexander Neundorf, <neundorf@kde.org> # |