Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Documentation
[simgrid.git] / doc / doxygen / module-smpi.doc
index 4bf0e5a..2410812 100644 (file)
@@ -1,5 +1,5 @@
 /** 
-@defgroup SMPI_API      SMPI: Semulate real MPI applications
+@defgroup SMPI_API      SMPI: Simulate real MPI applications
 @brief Programming environment for the simulation of MPI applications
     
 This programming environment enables the study of MPI application by
@@ -93,6 +93,12 @@ before giving SMPI a spin. Actually, that's very simple even if it's
 the first time you use MPI code: just use smpicc as a compiler (in
 replacement of gcc or your usual compiler), and you're set.
 
+\note 
+    Some configure scripts ("./configure") will test the compiler by 
+    compiling some simple example scripts. To make this work, you 
+    must set the <b>SMPI_PRETEND_CC</b> environment variable to
+    some arbitrary value, for instance "export SMPI_PRETEND_CC=1"
+
 \section SMPI_executing Executing your code on top of the simulator
 
 This is done though the <tt>smpirun</tt> script as follows.
@@ -504,7 +510,7 @@ Example: adding a "pair" version of the Alltoall collective.
 
  - To register the new version of the algorithm, simply add a line to the corresponding macro in src/smpi/colls/cools.h ( add a "COLL_APPLY(action, COLL_ALLTOALL_SIG, pair)" to the COLL_ALLTOALLS macro ). The algorithm should now be compiled and be selected when using --cfg=smpi/alltoall:pair at runtime.
 
- - To add a test for the algorithm inside Simgrid's test suite, juste add the new algorithm name in the ALLTOALL_COLL list found inside buildtools/cmake/Tests.cmake . When running ctest, a test for the new algorithm should be generated and executed. If it does not pass, please check your code or contact us.
+ - To add a test for the algorithm inside Simgrid's test suite, juste add the new algorithm name in the ALLTOALL_COLL list found inside teshsuite/smpi/CMakeLists.txt . When running ctest, a test for the new algorithm should be generated and executed. If it does not pass, please check your code or contact us.
 
  - Feel free to push this new algorithm to the SMPI repository using Git.