Browse Source

doc/doxygen/chapters/13offline_performance_tools.doxy: add link to option documentation

Nathalie Furmento 10 years ago
parent
commit
d54ae630d3
1 changed files with 7 additions and 5 deletions
  1. 7 5
      doc/doxygen/chapters/13offline_performance_tools.doxy

+ 7 - 5
doc/doxygen/chapters/13offline_performance_tools.doxy

@@ -119,8 +119,9 @@ $ vite paje.trace
 To get names of tasks instead of "unknown", fill the optional
 To get names of tasks instead of "unknown", fill the optional
 starpu_codelet::name, or use a performance model for them.
 starpu_codelet::name, or use a performance model for them.
 Details of the codelet execution can be obtained by passing
 Details of the codelet execution can be obtained by passing
-<c>--enable-paje-codelet-details</c> and using a recent enough version of ViTE
-(at least r1430).
+\ref enable-paje-codelet-details "--enable-paje-codelet-details" when
+configuring StarPU and using a recent enough version of ViTE (at least
+r1430).
 
 
 In the MPI execution case, collect the trace files from the MPI nodes, and
 In the MPI execution case, collect the trace files from the MPI nodes, and
 specify them all on the command <c>starpu_fxt_tool</c>, for instance:
 specify them all on the command <c>starpu_fxt_tool</c>, for instance:
@@ -133,9 +134,10 @@ By default, all tasks are displayed using a green color. To display tasks with
 varying colors, pass option <c>-c</c> to <c>starpu_fxt_tool</c>.
 varying colors, pass option <c>-c</c> to <c>starpu_fxt_tool</c>.
 
 
 To identify tasks precisely, the application can set the ::tag_id field of the
 To identify tasks precisely, the application can set the ::tag_id field of the
-tasks (or use STARPU_TAG_ONY when using starpu_task_insert), and with a recent
-enough version of vite (>= r1430) and the <c>--enable-paje-codelet-details</c>
-configure option, the value of the tag will show up in the trace.
+tasks (or use STARPU_TAG_ONLY when using starpu_task_insert()), and with a recent
+enough version of vite (>= r1430) and the
+\ref enable-paje-codelet-details "--enable-paje-codelet-details"
+StarPU configure option, the value of the tag will show up in the trace.
 
 
 Traces can also be inspected by hand by using the tool <c>fxt_print</c>, for instance:
 Traces can also be inspected by hand by using the tool <c>fxt_print</c>, for instance: