Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New functionality: possibility for libraries to register globals on each process...
[simgrid.git] / doc / module-gras.doc
index af308c5..b476fe1 100644 (file)
 
     \section GRAS_maingen_script Generating the main()s manually with
     
-    This is done by the gras_stub_generator script, which lives for now in
-    the examples/gras/ directory. Here is the calling syntax:
-    \verbatim gras_stub_generator <project_name> <deployment_file>\endverbatim
+    This is done by the gras_stub_generator program, which gets installed on
+    <tt>make install</tt> (the source resides in the tools/gras/ directory).
+    Here is the calling syntax: 
+    \verbatim gras_stub_generator <project_name> <deployment_file.xml>\endverbatim
     
     It parses the deployment file, searching for all the kind of processes
     you have in your project. It then generates the following C files:
-     - a file _<project_name>_<process_kind>.c for each process kind you
+     - a <tt>_<project_name>_<process_kind>.c</tt> file for each process kind you
        have\n
        They are used to launch your project in real life. They
        contain a main() in charge of initializing the GRAS infrastructure and
        launching your code afterward.
-     - a file _<project_name>_simulator.c.\n
+     - a <tt>_<project_name>_simulator.c</tt> file.\n
        This file is suited to the simulation mode. It contains a main()
        function initializing the simulator and launching your project within.
     
     example: \verbatim int client(int argc,char *argv[]);\endverbatim
     
     Unfortunately, all this is still partially documented. I guess I ought
-    to improve this situation somehow. In the meanwhile, check the script
-    source code, and the generated code, sorry.
-    
-    \warning All this is about the old description file from SimGrid2 and
-    should be updated to the new SimGrid3 format. We have to change both the
-    code and this documentation.
-    
+    to improve this situation somehow. In the meanwhile, check the generated 
+    code and maybe also the GRAS \ref GRAS_example, sorry. 
+        
     \section GRAS_maingen_make Integration within your Makefile 
     
     The easiest to set it up is to add the following chunk at the end of
 \verbatim NAME=your_project_name
  PROCESSES=list of processes type in your project
 
- $(foreach proc, $(PROCESSES), _$(NAME)_$(proc).c) _$(NAME)_simulator.c: $(NAME).c $(NAME)_deployment.txt
-        path/to/gras_stub_generator $(NAME) $(NAME)_deployment.txt >/dev/null
+ $(foreach proc, $(PROCESSES), _$(NAME)_$(proc).c) _$(NAME)_simulator.c: $(NAME).c $(NAME)_deployment.xml
+        path/to/gras_stub_generator $(NAME) $(NAME)_deployment.xml >/dev/null
 \endverbatim
 
     Of course, your personal millage may vary. For the \ref GRAS_ex_ping, may read:
-\verbatim _ping_client.c _ping_server.c _ping_simulator.c: ping.c ping_deployment.txt 
-        $(srcdir)/../gras_stub_generator ping ping_deployment.txt >/dev/null
-\endverbatim   
+\verbatim _ping_client.c _ping_server.c _ping_simulator.c: ping.c ping_deployment.xml 
+        $(top_srcdir)/tools/gras/gras_stub_generator ping ping_deployment.xml >/dev/null
+\endverbatim
 
      */