Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add docs
authornavarro <navarro@caraja.(none)>
Tue, 30 Oct 2012 14:05:30 +0000 (15:05 +0100)
committernavarro <navarro@caraja.(none)>
Tue, 30 Oct 2012 14:05:30 +0000 (15:05 +0100)
doc/dev_guide/doxygen/simgrid.doc
doc/dev_guide/doxygen/xps.doc

index ea13aa6..04660f5 100644 (file)
@@ -1,8 +1,57 @@
 /*! 
 \page simgrid SimGrid Developer Guide - SimGrid
 
+We start to put TAGS in simgrid source code for having tutorials to see where is the important parts ans steps to create:
+\li a new MSG functions or a new API.
+\li a new model in surf.
+\li new tags in xml files
+
 \section simgrid_dev_guide_api How to add a new MSG function?
+
+Search for expression \"TUTORIAL: New API\".
+\verbatim
+user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New API"
+ 0 msg/msg_new_api.c             15 /* TUTORIAL: New API*/
+ 1 simix/smx_smurf.c            582 /* TUTORIAL: New API*/
+ 2 simix/smx_smurf.c            616 /* TUTORIAL: New API*/
+ 3 simix/smx_smurf_private.h    102 /* TUTORIAL: New API*/
+ 4 simix/smx_smurf_private.h    629 /* TUTORIAL: New API*/
+ 5 simix/smx_private.h           28 /* TUTORIAL: New API*/
+ 6 simix/smx_private.h          101 /* TUTORIAL: New API*/
+ 7 simix/smx_private.h          182 /* TUTORIAL: New API*/
+ 8 simix/smx_global.c           454 /* TUTORIAL: New API*/
+ 9 simix/smx_new_api.c            8 /* TUTORIAL: New API*/
+10 simix/smx_user.c            1684 /* TUTORIAL: New API*/
+11 simix/smx_new_api_private.h    8 /* TUTORIAL: New API*/
+12 simix/smx_process.c          338 /* TUTORIAL: New API*/
+\endverbatim
+
 \section simgrid_dev_guide_model How to add a new model in surf?
-\section simgrid_dev_guide_tag What is How to add a new tag for xml files?
+Search for expression \"TUTORIAL: New model\".
+\verbatim
+user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New model"
+0 surf/new_model_private.h   2 /* TUTORIAL: New model
+1 surf/surf.c              213 /* TUTORIAL: New model*/
+2 surf/surf_config.c       380 /* TUTORIAL: New model*/
+3 surf/surf_config.c       746 /* TUTORIAL: New model*/
+4 surf/new_model.c           8 /* TUTORIAL: New model*/
+5 include/surf/surf.h      157 /* TUTORIAL: New model*/
+6 include/surf/surf.h      345 /* TUTORIAL: New model*/
+7 include/surf/surf.h      661 /* TUTORIAL: New model*/
+\endverbatim
 
+\section simgrid_dev_guide_tag What is How to add a new tag for xml files?
+Search for expression \"TUTORIAL: New TAG\".
+\verbatim
+user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New TAG"
+0 surf/sg_platf.c                    43 /* TUTORIAL: New TAG*/
+1 surf/sg_platf.c                    89 /* TUTORIAL: New TAG*/
+2 surf/sg_platf.c                   124 /* TUTORIAL: New TAG*/
+3 surf/sg_platf.c                   337 /* TUTORIAL: New TAG*/
+4 surf/surfxml_parse.c              769 /* TUTORIAL: New TAG*/
+5 surf/surf_private.h               205 /* TUTORIAL: New TAG*/
+6 surf/surfxml_parseplatf.c          64 /* TUTORIAL: New TAG*/
+7 surf/surfxml_parseplatf.c          85 /* TUTORIAL: New TAG*/
+8 include/simgrid/platf_interface.h  42 /* TUTORIAL: New TAG*/
+\endverbatim
 */
index 7cded30..2e052a5 100644 (file)
@@ -148,8 +148,8 @@ $ make pipol_test_list_images
 
 \section xps_dev_guide_pipol_nightly How to use nightly builds?
 
-All the pipol scrpts are located in \"<project/directory>/buildtools/pipol/\".
-If you modified them you have to update the pipol home directory by using this command: make sync-pipl.
+All the pipol scripts are located in \"<project/directory>/buildtools/pipol/\".
+If you modifie them you have to update the pipol home directory by using this command: make sync-pipl.
 
 It will copy those files:
 \verbatim
@@ -162,7 +162,7 @@ rc.ubuntu                                       100% 1875     1.8KB/s   00:00
 rc.windows                                      100%  494     0.5KB/s   00:00    
 Nightly_simgrid.sh                              100% 4004     3.9KB/s   00:00    
 Experimental_bindings.sh                        100% 1794     1.8KB/s   00:00
-\endverabtim 
+\endverbatim 
 
 \section xps_dev_guide_cdash How to report tests in cdash?
 
@@ -197,7 +197,7 @@ $ ctest -D ExperimentalSubmit
 
 \subsection xps_dev_guide_g5k_campaign How to execute g5k campaign?
 
-Quick steps deployment:
+Quick steps deployment for rennes:
 
 \li 1/ Create a G5K account
 
@@ -248,7 +248,7 @@ $  perl SGXP.pl --help
 
 \li 8/ Execute SGXP.pl with your parameters like
 \verbatim
-$  ./SGXP.pl --site=nancy --cluster=graphene,griffon --test=chord,goal --rev="09bbc8de,3ca7b9a13"
+$  ./SGXP.pl --site=nancy --cluster=graphene --test=chord,goal --rev="09bbc8de,3ca7b9a13"
 \endverbatim
 
 \subsection xps_dev_guide_g5k_log How to analyze logs?