Improve MSG_file_read() and MSG_file_write()

[simgrid.git] / doc / doxygen / introduction.doc

diff --git a/doc/doxygen/introduction.doc b/doc/doxygen/introduction.doc
index ea50d03..0851aff 100644 (file)
--- a/doc/doxygen/introduction.doc
+++ b/doc/doxygen/introduction.doc
@@ -105,19 +105,10 @@ available on the [online documentation][fn:4] and in the tutorials:
 
 ## Installing SimGrid
 
-    sudo apt-get install simgrid   
-    
-This tutorial requires simgrid 3.8 at last so you may need to get
-the [debian package](http://packages.debian.org/unstable/main/simgrid). Here is a shortcut:
-
-- AMD64: http://ftp.de.debian.org/debian/pool/main/s/simgrid/simgrid_3.8.1-2_amd64.deb
-- i386: http://ftp.de.debian.org/debian/pool/main/s/simgrid/simgrid_3.8.1-2_i386.deb
-
-Then
+    sudo apt-get install libsimgrid-dev
 
-~~~~{.sh}
-sudo dpkg -i simgrid_3.8*.deb
-~~~~
+This tutorial requires simgrid 3.8 at least so you may need to get
+the [debian packages](http://packages.debian.org/libsimgrid-dev).
 
 # Recommended Steps
 
@@ -160,7 +151,7 @@ sudo apt-get install vite
 ~~~~
 
 # Let's get Started
-## Setting up and Compiling.
+## Setting up and Compiling
    
 The corresponding archive with all source files and platform files
 can be obtained [here](http://simgrid.gforge.inria.fr/tutorials/msg-tuto/msg-tuto.tgz).
@@ -196,8 +187,8 @@ For a more "fancy" output, you can try:
 For a really fancy output, you should use [viva/triva][fn:1]:
 
 ~~~~{.sh}
-./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:1 \
-    --cfg=tracing/uncategorized:1 --cfg=viva/uncategorized:uncat.plist
+./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:yes \
+    --cfg=tracing/uncategorized:yes --cfg=viva/uncategorized:uncat.plist
 LANG=C ; viva simgrid.trace uncat.plist
 ~~~~
  
@@ -205,16 +196,16 @@ For a more classical Gantt-Chart visualization, you can produce a
 [Paje][fn:5] trace:
 
 ~~~~{.sh}
-./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:1 \
-    --cfg=tracing/msg/process:1
+./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:yes \
+    --cfg=tracing/msg/process:yes
 LANG=C ; Paje simgrid.trace
 ~~~~
 
 Alternatively, you can use [vite][fn:6].
 
 ~~~~{.sh}
-./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:1 \
-    --cfg=tracing/msg/process:1 --cfg=tracing/basic:1
+./masterworker0 platforms/platform.xml deployment0.xml --cfg=tracing:yes \
+    --cfg=tracing/msg/process:yes --cfg=tracing/basic:yes
 vite simgrid.trace
 ~~~~
 
@@ -312,14 +303,14 @@ In the current version, the number of tasks is defined in the
 worker arguments. Hence, tasks are created at the very beginning of
 the simulation. Instead, create tasks as needed and provide a time
 limit indicating when it stops sending tasks. To this end, you will
-obviously need to know what time it is[fn:7]:
+obviously need to know what time it is ([reference manual][fn:7]):
 
 ~~~~{.c}
 double MSG_get_clock(void);
 ~~~~
 
 Otherwise, a quite effective way of terminating the simulation
-would be to use some of the following function[fn:7]:
+would be to use some of the following [function][fn:7]:
 
 ~~~~{.c}
 void MSG_process_kill(msg_process_t process);
@@ -352,7 +343,7 @@ tasks processed). These debug messages can be activated as follows:
 ## Using the Tracing Mechanism
 
 SimGrid can trace all resource consumption and the outcome can be
-displayed with viva as illustrated [[*Setting%20up%20and%20Compiling.][here]]. However, when several
+displayed with viva as illustrated in the section "Setting up and Compiling". However, when several
 masters are deployed, it is hard to understand what happens. 
 
 ~~~~{.xml}
@@ -378,7 +369,7 @@ masters are deployed, it is hard to understand what happens.
 ~~~~
 
 So let's use categories to track more precisely who does what and
-when[fn:7].
+[when][fn:7].
 
 ~~~~{.c}
 void TRACE_category(const char *category);
@@ -388,8 +379,8 @@ void MSG_task_set_category (msg_task_t task, const char *category);
 The outcome can then be visualized as follows:
 
 ~~~~{.sh}
-./masterworker3 platforms/platform.xml deployment3.xml --cfg=tracing:1\
-    --cfg=tracing/categorized:1 --cfg=viva/categorized:viva_cat.plist
+./masterworker3 platforms/platform.xml deployment3.xml --cfg=tracing:yes\
+    --cfg=tracing/categorized:yes --cfg=viva/categorized:viva_cat.plist
 LANG=C; viva simgrid.trace viva_cat.plist
 ~~~~
 
@@ -399,8 +390,8 @@ and there are several masters deployed on the platform. Using a
 Gantt-chart visualization may help:
 
 ~~~~{.sh}
-./masterworker3 platforms/platform.xml deployment3.xml --cfg=tracing:1 \
-    --cfg=tracing/msg/process:1
+./masterworker3 platforms/platform.xml deployment3.xml --cfg=tracing:yes \
+    --cfg=tracing/msg/process:yes
 LANG=C; Paje simgrid.trace
 ~~~~
 
@@ -418,7 +409,7 @@ name. This way, the master can keep track of which workers are idle
 and willing to work.
 
 To know whether it has pending requests, the master can use the
-following function[fn:7]:
+following [function][fn:7]:
 
 ~~~~{.c}
 int MSG_task_listen(const char *alias);
@@ -426,7 +417,7 @@ int MSG_task_listen(const char *alias);
 
 If so, it should get the request and push the corresponding host
 into a dynar so that they can later be retrieved when sending a
-real task[fn:7].
+real [task][fn:7].
 
 ~~~~{.c}
 xbt_dynar_t xbt_dynar_new(const unsigned long elm_size,
@@ -439,7 +430,7 @@ unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
 As you will soon realize, with such simple mechanisms, simple
 deadlocks will soon appear. They can easily be removed with a
 simple polling mechanism, hence the need for the following
-function[fn:7]:
+[function][fn:7]:
 
 ~~~~{.c}
 msg_error_t MSG_process_sleep(double nb_sec);