Blob Blame History Raw
From 4a16ae0eb9b5f542877100364f92b77fa30c987e Mon Sep 17 00:00:00 2001
From: Alexander Neundorf <neundorf@kde.org>
Date: Sat, 9 May 2009 11:31:03 +0000
Subject: [PATCH 13/33] -add documentation -adapt to changes in
 KDECTestNightly.cmake in kdesdk

Alex



svn path=/trunk/kdesupport/automoc/; revision=965571
---
 Automoc4Nightly.cmake | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/Automoc4Nightly.cmake b/Automoc4Nightly.cmake
index a4cd5a8..ad3aeb9 100644
--- a/Automoc4Nightly.cmake
+++ b/Automoc4Nightly.cmake
@@ -1,5 +1,21 @@
+# This is a script for running a Nightly build of automoc4.
+# It is ready for testing.
+# To adapt it for other projects, basically only the KDE_CTEST_VCS_REPOSITORY variable
+# has to be changed.
+#
+# It uses the file KDECTestNightly.cmake, which is in KDE svn in kdesdk/cmake/modules/. 
+# You need to have this file on some location on your system and then point the environment variable
+# KDECTESTNIGHTLY_DIR to the directory containing this file when running this script.
+#
+# For more details have a look at kdelibs/KDELibsNightly.cmake in KDE svn 
+#
+# Alex <neundorf AT kde.org>
+
+# The VCS of KDE is "svn", also specify the repository
 set(KDE_CTEST_VCS svn)
 set(KDE_CTEST_VCS_REPOSITORY https://svn.kde.org/home/kde/trunk/kdesupport/automoc)
+
+# for now hardcode the generator to "Unix Makefiles"
 set(CTEST_CMAKE_GENERATOR "Unix Makefiles" )
 
 # set(CTEST_AVOID_SPACES FALSE)
@@ -14,20 +30,28 @@ Set the environment variable KDECTESTNIGHTLY_DIR  to the directory where this fi
 In KDE svn it is in kdesdk/cmake/modules/ ")
 endif(NOT fileIncluded)
 
+# set up binary dir, source dir, etc.
 kde_ctest_setup("${CMAKE_CURRENT_LIST_FILE}")
 
 ctest_empty_binary_directory("${CTEST_BINARY_DIRECTORY}")
 ctest_start(Nightly)
 ctest_update(SOURCE "${CTEST_SOURCE_DIRECTORY}" )
 
+# read some settings
 include("${CTEST_SOURCE_DIRECTORY}/CTestConfig.cmake")
 include("${CTEST_SOURCE_DIRECTORY}/CTestCustom.cmake" OPTIONAL)
 
+# if CMAKE_INSTALL_PREFIX was defined on the command line, put it in the initial cache, so cmake gets it
 kde_ctest_write_initial_cache("${CTEST_BINARY_DIRECTORY}" CMAKE_INSTALL_PREFIX )
 
+# configure, build, test, submit
 ctest_configure(BUILD "${CTEST_BINARY_DIRECTORY}" )
 ctest_build(BUILD "${CTEST_BINARY_DIRECTORY}" )
 ctest_test(BUILD "${CTEST_BINARY_DIRECTORY}" )
 ctest_submit()
 
-kde_ctest_install( "${CTEST_BINARY_DIRECTORY}" )
+# optionally install afterwards, so additional nightly builds can use this current install 
+# (e.g. kdepimlibs could use this kdelibs install)
+if(DO_INSTALL)
+   kde_ctest_install( "${CTEST_BINARY_DIRECTORY}" )
+endif(DO_INSTALL)
-- 
2.4.3