ctest/README.txt

   1 This folder provides ctest scripts to automatically build anyone
   2 of the 'creatools', test it and submit results to creatis dashboard.
   3
   4 ----------------
   5  INSTRUCTIONS
   6 ----------------
   7
   8 * All ctest script files in this folder have the following format :
   9   PROJECT-OS.ctest (e.g. crea-linux.ctest for crea project on linux platforms
  10                          bbtk-osx.ctest   for bbtk project on OsX   platforms)
  11
  12 * The default configuration is to build and run the tests in ${HOME}/dashboards,
  13 (to be created by user)
  14   This location is stored by ctest in the var CTEST_DASHBOARD_ROOT
  15
  16 * You have to :
  17
  18 1) Create a initial CMakeCache.txt corresponding to your machine config :
  19
  20    a) CVS Checkout the project to test
  21    b) Configure the project manually with cmake (ccmake or CMakeSetup), setting
  22    your system/install specific options (libraries paths, options, build type, ...)
  23    c) Copy the file 'CMakeCache.txt' from the build tree to your testing directory
  24     (where you will run ctest, usually the same than CTEST_DASHBOARD_ROOT),
  25     and rename it with a meaningfull name like :
  26     (PROJECT-BUILDTYPE-CMakeCache.txt, e.g. crea-debug-CMakeCache.txt)
  27    d) Edit the copied file and comment out (type an initial #) all lines which
  28     make explicit reference to the build directory
  29     (the directory where you configured with cmake, use the 'find' tool of your
  30      editor). Typically for crea, you'll have to comment out the following lines :
  31  #//Value Computed by CMake
  32  #crea_BINARY_DIR:STATIC=/home/guigues/coding/Build/crea
  33  #//Value Computed by CMake
  34  #crea_SOURCE_DIR:STATIC=/home/guigues/coding/CreaTools/crea
  35  #//This is the directory where this CMakeCahe.txt was created
  36  #CMAKE_CACHEFILE_DIR:INTERNAL=/home/guigues/coding/Build/crea
  37  #//Start directory with the top level CMakeLists.txt file for this
  38  #// project
  39  #CMAKE_HOME_DIRECTORY:INTERNAL=/home/guigues/coding/CreaTools/crea
  40
  41 2) Copy in CTEST_DASHBOARD_ROOT the right ctest file to another filename,
  42    e.g. copy 'crea-linux.ctest' to 'crea-mymachine-debug.ctest'
  43
  44 3) Edit the new file and set :
  45    * The architecture description, typically os+compiler with versions
  46       e.g. fc9-gcc4.3.0, win32-vs8, etc.
  47    * The build type, e.g. debug, release...
  48    * The name of the CMakeCache.txt file to use as initial cache file (see 3)
  49    below)
  50    * You can also customize the CTEST_DASHBOARD_ROOT folder
  51
  52 4) Run ctest with the script, typically :
  53 > ctest -S crea-linux-mymachine-debug.ctest -V
  54 The -V option sets ctest to verbose mode, use -VV if you want to see each
  55 command issued...
  56
  57
  58 * To schedule automatic build, see :
  59   http://www.vtk.org/Wiki/CMake_Scripting_Of_CTest