Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move MSG and SimDag examples out of the sight of users
[simgrid.git] / doc / doxygen / inside_cmake.doc
index ffb7d5c..6f31b64 100644 (file)
@@ -61,18 +61,18 @@ upon them by error.
 
 To add a new example, the first thing is to find the right place to add it. The examples/ directory is organized as 
 follows:
- - examples/java/ for examples using the Java bindings to the MSG API. This directory contains packages (app, async, 
+ - examples/deprecated/java/ for examples using the Java bindings to the MSG API. This directory contains packages (app, async, 
    cloud, ...) which in turn contain individual examples. If your new example fits in an existing package, add it here,
    or create a new package otherwise. 
- - examples/msg/ for examples using the MSG API. Here the naming convention is package-example (e.g., app-masterworker).
+ - examples/deprecated/msg/ for examples using the MSG API. Here the naming convention is package-example (e.g., app-masterworker).
    Again, please try to fit to an existing package before creating a new one.
  - examples/platforms/ only contains platforms descriptions in the XML format (see @ref platform for details)
  - examples/s4u/ for examples using the emerging S4U API
- - examples/simdag/ for examples using the SimDag API
+ - examples/deprecated/simdag/ for examples using the SimDag API
  - examples/smpi/ or examples using the SMPI API
 
 In each of these directories, there is a CMakeLists.txt file that has to be edited to include the new examples. For 
-instance, examples/msg/CMakeLists.txt starts with a loop over all the (currently) existing tests in which we
+instance, examples/deprecated/msg/CMakeLists.txt starts with a loop over all the (currently) existing tests in which we
  - compile and link the source file (which has to be named as the directory
  - add the source and tesh files to the distribution.
 
@@ -123,7 +123,7 @@ foreach(x app-bittorrent app-chainsend app-masterworker app-pingpong app-token-r
           async-wait async-waitall async-waitany cloud-capping cloud-masterworker cloud-migration cloud-simple 
           cloud-two-tasks dht-chord dht-kademlia platform-failures io-file io-remote io-storage task-priority 
           process-kill process-migration process-suspend platform-properties synchro-semaphore process-startkilltime)
-  ADD_TESH_FACTORIES(msg-${x} "thread;ucontext;raw;boost" --setenv bindir=${CMAKE_BINARY_DIR}/examples/msg/${x} --setenv srcdir=${CMAKE_HOME_DIRECTORY}/examples/platforms --cd ${CMAKE_HOME_DIRECTORY}/examples/msg/${x} ${x}.tesh)
+  ADD_TESH_FACTORIES(msg-${x} "thread;ucontext;raw;boost" --setenv bindir=${CMAKE_BINARY_DIR}/examples/deprecated/msg/${x} --setenv srcdir=${CMAKE_HOME_DIRECTORY}/examples/platforms --cd ${CMAKE_HOME_DIRECTORY}/examples/deprecated/msg/${x} ${x}.tesh)
 endforeach()
 @endverbatim