From 605c7c4a491fa6014e005d00e6a1d02a63aa2d51 Mon Sep 17 00:00:00 2001 From: Alexander Neundorf Date: Thu, 14 Aug 2008 22:13:31 +0000 Subject: -add some documentation Alex svn path=/trunk/KDE/kdelibs/; revision=847189 --- modules/MacroEnsureOutOfSourceBuild.cmake | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'modules') 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() # MACRO_ENSURE_OUT_OF_SOURCE_BUILD() +# 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, # -- cgit v1.2.1