preparing for tracing documentation (a new module called TRACE has been defined)

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 30e9c7e..756f275 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -629,6 +629,7 @@ INPUT                  = index.doc \
                          module-amok.doc \
                          module-sd.doc \
                          module-surf.doc \
+                         module-trace.doc \
                          gtut-main.doc \
                          gtut-introduction.doc \
                          gtut-tour.doc \
@@ -652,6 +653,7 @@ INPUT                  = index.doc \
                          gtut-tour-16-exchangecb.doc \
                          gtut-howto.doc \
                          gtut-howto-design.doc \
+                         @top_srcdir@/src/instr/ \
                          @top_srcdir@/include/ \
                          @top_srcdir@/include/msg \
                          @top_srcdir@/include/gras \
@@ -1547,7 +1549,8 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = DOXYGEN \
                          DOXYGEN_SKIP_IT \
                          XBT_PUBLIC= \
-                         XBT_INLINE=
+                         XBT_INLINE= \
+                         HAVE_TRACING
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.

diff --git a/doc/module-trace.doc b/doc/module-trace.doc
new file mode 100644 (file)
index 0000000..de01c4a
--- /dev/null
+++ b/doc/module-trace.doc
@@ -0,0 +1,20 @@
+/**
+\addtogroup TRACE_API
+
+\section TRACE_doc TRACE documentation
+- \ref TRACE_category
+- \ref TRACE_mark
+- \ref TRACE_user_variables
+
+\defgroup TRACE_category Tracing categories
+\ingroup TRACE_API
+\brief Functions to declare tracing categories.
+
+\defgroup TRACE_mark Tracing marks
+\ingroup TRACE_API
+\brief Functions to declare and create tracing marks.
+
+\defgroup TRACE_user_variables Tracing user variables
+\ingroup TRACE_API
+\brief Functions to declare and define user variables associated to resources.
+*/
\ No newline at end of file

diff --git a/doc/modules.doc b/doc/modules.doc
index 0d80531..76e25a1 100644 (file)
--- a/doc/modules.doc
+++ b/doc/modules.doc
@@ -145,3 +145,24 @@ Please note that as it is not really intended for public use, this
 module is only partially documented. 
 */
 
+
+/**
+@defgroup TRACE_API TRACE
+@ingroup SimGrid_API
+@brief Tracing mechanism and its functions.
+
+SimGrid can trace the resource (of hosts and links) utilization using
+any of its programming interfaces (MSG, SimDAG and SMPI). This means
+that the tracing will register how much power is used for each host
+and how much bandwidth is used for each link of the platform.
+
+The idea of the tracing facilities is to give SimGrid users to
+possibility to classify MSG and SimDAG tasks by category, tracing the
+platform utilization (hosts and links) for each of the categories.
+The API enables the declaration of categories and a function to
+associate them to the tasks (MSG and SD). The tasks that are not
+classified according to a category are not traced. If no categories
+are specified, simulations can still be traced using a special
+parameter in the command line (see \ref tracing_tracing for details).
+*/
+