ソースを参照

doc/doxygen: improve contents

Nathalie Furmento 12 年 前
コミット
77e3245fdc

+ 2 - 2
doc/doxygen/Makefile.am

@@ -156,8 +156,8 @@ $(DOX_PDF): $(DOX_TAG) refman.tex
 	cp $(top_srcdir)/doc/doxygen/chapters/version.sty $(DOX_DIR)
 	cd $(DOX_LATEX_DIR); \
 	rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \
-	sed -i -e 's/__env__/\\_Environment Variables!/' -e 's/\\-\\_\\-\\-\\_\\-env\\-\\_\\-\\-\\_\\-//'  EnvironmentVariables.tex ;\
-	sed -i -e 's/__configure__/\\_Configure Options!/' -e 's/\\-\\_\\-\\-\\_\\-configure\\-\\_\\-\\-\\_\\-//'  ConfigureOptions.tex ;\
+	sed -i -e 's/__env__/\\_Environment Variables!/' -e 's/\\-\\_\\-\\-\\_\\-env\\-\\_\\-\\-\\_\\-//' ExecutionConfigurationThroughEnvironmentVariables.tex ;\
+	sed -i -e 's/__configure__/\\_Configure Options!/' -e 's/\\-\\_\\-\\-\\_\\-configure\\-\\_\\-\\-\\_\\-//' CompilationConfiguration.tex ;\
 	$(PDFLATEX) refman.tex; \
 	$(MAKEINDEX) refman.idx;\
 	$(PDFLATEX) refman.tex; \

+ 27 - 29
doc/doxygen/chapters/api/codelet_and_tasks.doxy

@@ -12,7 +12,7 @@
 
 \enum starpu_codelet_type
 \ingroup API_Codelet_And_Tasks
-Describes the type of parallel task. See \ref Parallel_Tasks for details.
+Describes the type of parallel task. See \ref ParallelTasks for details.
 \var starpu_codelet_type::STARPU_SEQ
 \ingroup API_Codelet_And_Tasks
 (default) for classical sequential tasks.
@@ -142,7 +142,7 @@ task, 0 otherwise.
 Optional field to specify the type of the codelet. The default is
 ::STARPU_SEQ, i.e. usual sequential implementation. Other values
 (::STARPU_SPMD or ::STARPU_FORKJOIN declare that a parallel implementation
-is also available. See \ref Parallel_Tasks for details.
+is also available. See \ref ParallelTasks for details.
 
 \var starpu_codelet::max_parallelism
 Optional field. If a parallel implementation is available, this
@@ -207,23 +207,22 @@ Specify the number of arguments taken by the codelet. These arguments
 are managed by the DSM and are accessed from the <c>void *buffers[]</c>
 array. The constant argument passed with the field starpu_task::cl_arg
 is not counted in this number. This value should not be above
-STARPU_NMAXBUFS.
+\ref STARPU_NMAXBUFS.
 
 \var starpu_codelet::modes
 Is an array of ::starpu_data_access_mode. It describes the required
 access modes to the data neeeded by the codelet (e.g. ::STARPU_RW). The
 number of entries in this array must be specified in the field
-starpu_codelet::nbuffers, and should not exceed STARPU_NMAXBUFS. If
-unsufficient, this value can be set with the <c>--enable-maxbuffers</c>
-option when configuring StarPU.
+starpu_codelet::nbuffers, and should not exceed \ref STARPU_NMAXBUFS. If
+unsufficient, this value can be set with the configure option \ref enable-maxbuffers.
 
 \var starpu_codelet::dyn_modes
 Is an array of ::starpu_data_access_mode. It describes the required
 access modes to the data neeeded by the codelet (e.g. ::STARPU_RW).
 The number of entries in this array must be specified in the field
 starpu_codelet::nbuffers. This field should be used for codelets having a
-number of datas greater than STARPU_NMAXBUFS (see \ref
-Setting_the_Data_Handles_for_a_Task). When defining a codelet, one
+number of datas greater than \ref STARPU_NMAXBUFS (see \ref
+SettingTheDataHandlesForATask). When defining a codelet, one
 should either define this field or the field starpu_codelet::modes defined above.
 
 \var starpu_codelet::model
@@ -252,7 +251,7 @@ purposes.
 \ingroup API_Codelet_And_Tasks
 Initialize \p cl with default values. Codelets should
 preferably be initialized statically as shown in \ref
-Defining_a_Codelet. However such a initialisation is not always
+DefiningACodelet. However such a initialisation is not always
 possible, e.g. when using C++.
 
 \struct starpu_data_descr
@@ -285,18 +284,17 @@ field starpu_task::handles to specify the data handles accessed
 by the task. The access modes are now defined in the field
 starpu_codelet::mode.
 \var starpu_task::handles
-Is an array of starpu_data_handle_t. It specifies the handles to the
+Is an array of ::starpu_data_handle_t. It specifies the handles to the
 different pieces of data accessed by the task. The number of entries
 in this array must be specified in the field starpu_codelet::nbuffers,
-and should not exceed STARPU_NMAXBUFS. If unsufficient, this value can
-be set with the option <c>--enable-maxbuffers</c> when configuring
-StarPU.
+and should not exceed \ref STARPU_NMAXBUFS. If unsufficient, this value can
+be set with the configure option \ref enable-maxbuffers.
 \var starpu_task::dyn_handles
-Is an array of starpu_data_handle_t. It specifies the handles to the
+Is an array of ::starpu_data_handle_t. It specifies the handles to the
 different pieces of data accessed by the task. The number of entries
 in this array must be specified in the field starpu_codelet::nbuffers.
 This field should be used for tasks having a number of datas greater
-than STARPU_NMAXBUFS (see \ref Setting_the_Data_Handles_for_a_Task).
+than \ref STARPU_NMAXBUFS (see \ref SettingTheDataHandlesForATask).
 When defining a task, one should either define this field or the field
 starpu_task::handles defined above.
 
@@ -337,8 +335,8 @@ executed if the field is set to NULL.
 
 \var starpu_task::callback_arg (optional) (default: NULL)
 Optional field, the default value is <c>NULL</c>. This is the pointer
-passed to the callback function. This field is ignored if the
-callback_func is set to <c>NULL</c>.
+passed to the callback function. This field is ignored if the field
+starpu_task::callback_func is set to <c>NULL</c>.
 
 \var starpu_task::use_tag
 Optional field, the default value is 0. If set, this flag indicates
@@ -363,16 +361,16 @@ to process the task). Otherwise, starpu_task_submit() returns
 immediately.
 
 \var starpu_task::priority
-Optional field, the default value is STARPU_DEFAULT_PRIO. This field
+Optional field, the default value is ::STARPU_DEFAULT_PRIO. This field
 indicates a level of priority for the task. This is an integer value
 that must be set between the return values of the function
 starpu_sched_get_min_priority() for the least important tasks, and
 that of the function starpu_sched_get_max_priority() for the most
-important tasks (included). The STARPU_MIN_PRIO and STARPU_MAX_PRIO
+important tasks (included). The ::STARPU_MIN_PRIO and ::STARPU_MAX_PRIO
 macros are provided for convenience and respectively returns the value
 of starpu_sched_get_min_priority() and
 starpu_sched_get_max_priority(). Default priority is
-STARPU_DEFAULT_PRIO, which is always defined as 0 in order to allow
+::STARPU_DEFAULT_PRIO, which is always defined as 0 in order to allow
 static task initialization. Scheduling strategies that take priorities
 into account can use this parameter to take better scheduling
 decisions, but the scheduling policy may also ignore it.
@@ -414,7 +412,7 @@ will not free any task.
 \var starpu_task::regenerate
 Optional field. If this flag is set, the task will be re-submitted to
 StarPU once it has been executed. This flag must not be set if the
-destroy flag is set.
+flag starpu_task::destroy is set.
 
 \var starpu_task::status
 Optional field. Current state of the task.
@@ -424,7 +422,7 @@ Optional field. Profiling information for the task.
 
 \var starpu_task::predicted
 Output field. Predicted duration of the task. This field is only set
-if the scheduling strategy used performance models.
+if the scheduling strategy uses performance models.
 
 \var starpu_task::predicted_transfer
 Optional field. Predicted data transfer duration for the task in
@@ -447,8 +445,8 @@ only be used by StarPU.
 \var starpu_task::flops
 This can be set to the number of floating points operations that the
 task will have to achieve. This is useful for easily getting GFlops
-curves from starpu_perfmodel_plot(), and for the hypervisor load
-balancing.
+curves from the tool <c>starpu_perfmodel_plot</c>, and for the
+hypervisor load balancing.
 
 \var starpu_task::starpu_private
 \private
@@ -477,7 +475,7 @@ Initialize task with default values. This function is
 implicitly called by starpu_task_create(). By default, tasks initialized
 with starpu_task_init() must be deinitialized explicitly with
 starpu_task_clean(). Tasks can also be initialized statically, using
-STARPU_TASK_INITIALIZER.
+::STARPU_TASK_INITIALIZER.
 
 \def STARPU_TASK_INITIALIZER
 \ingroup API_Codelet_And_Tasks
@@ -491,7 +489,7 @@ Return the \p i th data handle of the given task. If the task
 is defined with a static or dynamic number of handles, will either
 return the \p i th element of the field starpu_task::handles or the \p
 i th element of the field starpu_task::dyn_handles (see \ref
-Setting_the_Data_Handles_for_a_Task)
+SettingTheDataHandlesForATask)
 
 \def STARPU_TASK_SET_HANDLE(struct starpu_task *task, starpu_data_handle_t handle, int i)
 \ingroup API_Codelet_And_Tasks
@@ -500,7 +498,7 @@ dat handle. If the task is defined with a static or dynamic number of
 handles, will either set the \p i th element of the field
 starpu_task::handles or the \p i th element of the field
 starpu_task::dyn_handles (see \ref
-Setting_the_Data_Handles_for_a_Task)
+SettingTheDataHandlesForATask)
 
 \def STARPU_CODELET_GET_MODE(struct starpu_codelet *codelet, int i)
 \ingroup API_Codelet_And_Tasks
@@ -509,7 +507,7 @@ codelet. If the codelet is defined with a static or dynamic number of
 handles, will either return the \p i th element of the field
 starpu_codelet::modes or the \p i th element of the field
 starpu_codelet::dyn_modes (see \ref
-Setting_the_Data_Handles_for_a_Task)
+SettingTheDataHandlesForATask)
 
 \def STARPU_CODELET_SET_MODE(struct starpu_codelet *codelet, enum starpu_data_access_mode mode, int i)
 \ingroup API_Codelet_And_Tasks
@@ -518,7 +516,7 @@ codelet. If the codelet is defined with a static or dynamic number of
 handles, will either set the \p i th element of the field
 starpu_codelet::modes or the \p i th element of the field
 starpu_codelet::dyn_modes (see \ref
-Setting_the_Data_Handles_for_a_Task)
+SettingTheData_HandlesForATask)
 
 \fn struct starpu_task * starpu_task_create(void)
 \ingroup API_Codelet_And_Tasks

+ 1 - 1
doc/doxygen/chapters/api/cuda_extensions.doxy

@@ -12,7 +12,7 @@
 \ingroup API_CUDA_Extensions
 This macro is defined when StarPU has been installed with CUDA
 support. It should be used in your code to detect the availability of
-CUDA as shown in Full source code for the 'Scaling a Vector' example.
+CUDA as shown in \ref FullSourceCodeVectorScal.
 
 \fn cudaStream_t starpu_cuda_get_local_stream(void)
 \ingroup API_CUDA_Extensions

+ 3 - 3
doc/doxygen/chapters/api/data_interfaces.doxy

@@ -245,7 +245,7 @@ Return the interface associated with \p handle on \p memory_node.
 Each data interface is provided with a set of field access functions.
 The ones using a void * parameter aimed to be used in codelet
 implementations (see for example the code in \ref
-Vector_Scaling_Using_StarPU_API).
+VectorScalingUsingStarPUAPI).
 
 \fn void *starpu_data_handle_to_pointer(starpu_data_handle_t handle, unsigned node)
 \ingroup API_Data_Interfaces
@@ -895,7 +895,7 @@ designated by \p interface.
 \ingroup API_Data_Interfaces
 
 Applications can provide their own interface as shown in \ref
-Defining_a_New_Data_Interface.
+DefiningANewDataInterface.
 
 \fn uintptr_t starpu_malloc_on_node(unsigned dst_node, size_t size)
 \ingroup API_Data_Interfaces
@@ -939,7 +939,7 @@ size footprint.
 \fn int starpu_data_interface_get_next_id(void)
 \ingroup API_Data_Interfaces
 Return the next available id for a newly created data interface
-(\ref Defining_a_New_Data_Interface).
+(\ref DefiningANewDataInterface).
 
 */
 

+ 9 - 9
doc/doxygen/chapters/api/data_management.doxy

@@ -10,14 +10,14 @@
 
 \brief This section describes the data management facilities provided
 by StarPU. We show how to use existing data interfaces in \ref
-Data_Interfaces, but developers can design their own data interfaces
-if required.
+API_Data_Interfaces, but developers can design their own data interfaces if
+required.
 
 \typedef starpu_data_handle_t
 \ingroup API_Data_Management
 StarPU uses ::starpu_data_handle_t as an opaque handle to
 manage a piece of data. Once a piece of data has been registered to
-StarPU, it is associated to a starpu_data_handle_t which keeps track
+StarPU, it is associated to a ::starpu_data_handle_t which keeps track
 of the state of the piece of data over the entire machine, so that we
 can maintain data consistency and locate data replicates for instance.
 
@@ -26,7 +26,7 @@ can maintain data consistency and locate data replicates for instance.
 This datatype describes a data access mode.
 \var starpu_data_access_mode::STARPU_NONE
 \ingroup API_Data_Management
-TODO!
+TODO
 \var starpu_data_access_mode::STARPU_R
 \ingroup API_Data_Management
 read-only mode.
@@ -75,7 +75,7 @@ simple structure containing the number of elements in the array, the
 size of the elements, and the address of the array in the appropriate
 address space (this address may be invalid if there is no valid copy
 of the array in the memory node). More informations on the data
-interfaces provided by StarPU are given in \ref Data_Interfaces.
+interfaces provided by StarPU are given in \ref API_Data_Interfaces.
 
 When a piece of data managed by StarPU is used by a task, the task
 implementation is given a pointer to an interface describing a valid
@@ -87,7 +87,7 @@ its data. For instance, the memory node associated to the different
 CPU workers represents main memory (RAM), the memory node associated
 to a GPU is DRAM embedded on the device. Every memory node is
 identified by a logical index which is accessible from the
-starpu_worker_get_memory_node function. When registering a piece of
+function starpu_worker_get_memory_node(). When registering a piece of
 data to StarPU, the specified memory node indicates where the piece of
 data initially resides (we also call this memory node the home node of
 a piece of data).
@@ -188,9 +188,9 @@ discarded without impacting the application.
 \fn void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
 \ingroup API_Data_Management
 This sets the codelets to be used for \p handle when it is
-accessed in STARPU_REDUX mode. Per-worker buffers will be initialized with
-the \p init_cl codelet, and reduction between per-worker buffers will be
-done with the \p redux_cl codelet.
+accessed in the mode ::STARPU_REDUX. Per-worker buffers will be initialized with
+the codelet \p init_cl, and reduction between per-worker buffers will be
+done with the codelet \p redux_cl.
 
 @name Access registered data from the application
 \ingroup API_Data_Management

+ 11 - 11
doc/doxygen/chapters/api/data_partition.doxy

@@ -108,8 +108,8 @@ the type starpu_data_filter.
 
 This section gives a partial list of the predefined partitioning
 functions for vector data. Examples on how to use them are shown in
-\ref Partitioning_Data. The complete list can be found in the file
-starpu_data_filters.h.
+\ref PartitioningData. The complete list can be found in the file
+<c>starpu_data_filters.h</c>.
 
 \fn void starpu_vector_filter_block(void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition
@@ -148,8 +148,8 @@ equal size, ignoring nparts. Thus, \p id must be <c>0</c> or <c>1</c>.
 
 This section gives a partial list of the predefined partitioning
 functions for matrix data. Examples on how to use them are shown in
-\ref Partitioning_Data. The complete list can be found in the file
-starpu_data_filters.h.
+\ref PartitioningData. The complete list can be found in the file
+<c>starpu_data_filters.h</c>.
 
 \fn void starpu_matrix_filter_block(void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition
@@ -188,8 +188,8 @@ available in examples/filters/shadow2d.c
 
 This section gives a partial list of the predefined partitioning
 functions for block data. Examples on how to use them are shown in
-\ref Partitioning_Data. The complete list can be found in the file
-starpu_data_filters.h. A usage example is available in
+\ref PartitioningData. The complete list can be found in the file
+<c>starpu_data_filters.h</c>. A usage example is available in
 examples/filters/shadow3d.c
 
 \fn void starpu_block_filter_block (void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
@@ -201,7 +201,7 @@ submatrix contains the remainder.
 \fn void starpu_block_filter_block_shadow (void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition
 This partitions a block along the X dimension, with a
-shadow border <p>filter_arg_ptr</p>, thus getting
+shadow border <c>filter_arg_ptr</c>, thus getting
 ((x-2*shadow)/\p nparts +2*shadow,y,z) blocks. If \p nparts does not
 divide x, the last submatrix contains the remainder. <b>IMPORTANT</b>:
 This can only be used for read-only access, as no coherency is
@@ -216,7 +216,7 @@ submatrix contains the remainder.
 \fn void starpu_block_filter_vertical_block_shadow (void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition
 This partitions a block along the Y dimension, with a
-shadow border <p>filter_arg_ptr</p>, thus getting
+shadow border <c>filter_arg_ptr</c>, thus getting
 (x,(y-2*shadow)/\p nparts +2*shadow,z) 3D matrices. If \p nparts does not
 divide y, the last submatrix contains the remainder. <b>IMPORTANT</b>:
 This can only be used for read-only access, as no coherency is
@@ -231,7 +231,7 @@ submatrix contains the remainder.
 \fn void starpu_block_filter_depth_block_shadow (void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition
 This partitions a block along the Z dimension, with a
-shadow border <p>filter_arg_ptr</p>, thus getting
+shadow border <c>filter_arg_ptr</c>, thus getting
 (x,y,(z-2*shadow)/\p nparts +2*shadow) blocks. If \p nparts does not
 divide z, the last submatrix contains the remainder. <b>IMPORTANT</b>:
 This can only be used for read-only access, as no coherency is
@@ -242,8 +242,8 @@ enforced for the shadowed parts.
 
 This section gives a partial list of the predefined partitioning
 functions for BCSR data. Examples on how to use them are shown in
-\ref Partitioning_Data. The complete list can be found in the file
-starpu_data_filters.h.
+\ref PartitioningData. The complete list can be found in the file
+<c>starpu_data_filters.h</c>.
 
 \fn void starpu_bcsr_filter_canonical_block (void *father_interface, void *child_interface, struct starpu_data_filter *f, unsigned id, unsigned nparts)
 \ingroup API_Data_Partition

+ 28 - 30
doc/doxygen/chapters/api/initialization.doxy

@@ -12,8 +12,8 @@
 structure for a driver
 \ingroup API_Initialization_and_Termination
 \var starpu_driver::type
-The type of the driver. Only STARPU_CPU_DRIVER,
-STARPU_CUDA_DRIVER and STARPU_OPENCL_DRIVER are currently supported.
+The type of the driver. Only ::STARPU_CPU_WORKER,
+::STARPU_CUDA_WORKER and ::STARPU_OPENCL_WORKER are currently supported.
 \var starpu_driver::id
 The identifier of the driver.
 
@@ -33,20 +33,20 @@ The environment variables overwrite the equivalent parameters.
 Will be initialized by starpu_conf_init(). Should not be set by hand.
 \var starpu_conf::sched_policy_name
 This is the name of the scheduling policy. This can also be specified
-with the STARPU_SCHED environment variable. (default = NULL).
+with the environment variable \ref STARPU_SCHED. (default = NULL).
 \var starpu_conf::sched_policy
 This is the definition of the scheduling policy. This field is ignored
 if starpu_conf::sched_policy_name is set. (default = NULL)
 \var starpu_conf::ncpus
 This is the number of CPU cores that StarPU can use. This can also be
-specified with the STARPU_NCPU environment variable. (default = -1)
+specified with the environment variable \ref STARPU_NCPU . (default = -1)
 \var starpu_conf::ncuda
 This is the number of CUDA devices that StarPU can use. This can also
-be specified with the STARPU_NCUDA environment variable. (default =
+be specified with the environment variable \ref STARPU_NCUDA. (default =
 -1)
 \var starpu_conf::nopencl
 This is the number of OpenCL devices that StarPU can use. This can
-also be specified with the STARPU_NOPENCL environment variable.
+also be specified with the environment variable \ref STARPU_NOPENCL.
 (default = -1)
 \var starpu_conf::nmic
 This is the number of MIC devices that StarPU can use. (default = -1)
@@ -57,7 +57,7 @@ This is the number of SCC devices that StarPU can use. (default = -1)
 If this flag is set, the starpu_conf::workers_bindid array indicates
 where the different workers are bound, otherwise StarPU automatically
 selects where to bind the different workers. This can also be
-specified with the STARPU_WORKERS_CPUID environment variable. (default = 0)
+specified with the environment variable \ref STARPU_WORKERS_CPUID. (default = 0)
 \var starpu_conf::workers_bindid
 If the starpu_conf::use_explicit_workers_bindid flag is set, this
 array indicates where to bind the different workers. The i-th entry of
@@ -69,8 +69,8 @@ provided by the hwloc library in case it is available.
 If this flag is set, the CUDA workers will be attached to the CUDA
 devices specified in the starpu_conf::workers_cuda_gpuid array.
 Otherwise, StarPU affects the CUDA devices in a round-robin fashion.
-This can also be specified with the STARPU_WORKERS_CUDAID environment
-variable. (default = 0)
+This can also be specified with the environment variable \ref
+STARPU_WORKERS_CUDAID. (default = 0)
 \var starpu_conf::workers_cuda_gpuid
 If the starpu_conf::use_explicit_workers_cuda_gpuid flag is set, this
 array contains the logical identifiers of the CUDA devices (as used by
@@ -79,8 +79,8 @@ cudaGetDevice()).
 If this flag is set, the OpenCL workers will be attached to the OpenCL
 devices specified in the starpu_conf::workers_opencl_gpuid array.
 Otherwise, StarPU affects the OpenCL devices in a round-robin fashion.
-This can also be specified with the STARPU_WORKERS_OPENCLID
-environment variable. (default = 0)
+This can also be specified with the environment variable \ref
+STARPU_WORKERS_OPENCLID. (default = 0)
 \var starpu_conf::workers_opencl_gpuid
 If the starpu_conf::use_explicit_workers_opencl_gpuid flag is set,
 this array contains the logical identifiers of the OpenCL devices to
@@ -104,7 +104,7 @@ array contains the logical identifiers of the SCC devices to be used.
 \var starpu_conf::bus_calibrate
 If this flag is set, StarPU will recalibrate the bus.  If this value
 is equal to <c>-1</c>, the default value is used.  This can also be
-specified with the STARPU_BUS_CALIBRATE environment variable. (default
+specified with the environment variable \ref STARPU_BUS_CALIBRATE. (default
 = 0)
 \var starpu_conf::calibrate
 If this flag is set, StarPU will calibrate the performance models when
@@ -112,7 +112,7 @@ executing tasks. If this value is equal to <c>-1</c>, the default
 value is used. If the value is equal to <c>1</c>, it will force
 continuing calibration. If the value is equal to <c>2</c>, the
 existing performance models will be overwritten. This can also be
-specified with the STARPU_CALIBRATE environment variable. (default =
+specified with the environment variable \ref STARPU_CALIBRATE. (default =
 0)
 \var starpu_conf::single_combined_worker
 By default, StarPU executes parallel tasks
@@ -123,8 +123,8 @@ only start one parallel task at a time (but other CPU and
 GPU tasks are not affected and can be run concurrently).
 The parallel task scheduler will however still however
 still try varying combined worker sizes to look for the
-most efficient ones. This can also be specified with the
-STARPU_SINGLE_COMBINED_WORKER environment variable.
+most efficient ones. This can also be specified with the environment
+variable \ref STARPU_SINGLE_COMBINED_WORKER.
 (default = 0)
 
 \var starpu_conf::mic_sink_program_path
@@ -134,33 +134,31 @@ architecture.
 \var starpu_conf::disable_asynchronous_copy
 This flag should be set to 1 to disable
 asynchronous copies between CPUs and all accelerators. This
-can also be specified with the
-STARPU_DISABLE_ASYNCHRONOUS_COPY environment variable. The
+can also be specified with the environment variable \ref
+STARPU_DISABLE_ASYNCHRONOUS_COPY. The
 AMD implementation of OpenCL is known to fail when copying
 data asynchronously. When using this implementation, it is
 therefore necessary to disable asynchronous data transfers.
 This can also be specified at compilation time by giving to
-the configure script the option
-<c>--disable-asynchronous-copy</c>. (default = 0)
+the configure script the option \ref disable-asynchronous-copy. (default = 0)
 \var starpu_conf::disable_asynchronous_cuda_copy
 This flag should be set to 1 to disable
 asynchronous copies between CPUs and CUDA accelerators.
-This can also be specified with the
-STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY environment variable.
+This can also be specified with the environment variable
+\ref STARPU_DISABLE_ASYNCHRONOUS_CUDA_COPY.
 This can also be specified at compilation time by giving to
-the configure script the option
-<c>--disable-asynchronous-cuda-copy</c>. (default = 0)
+the configure script the option \ref disable-asynchronous-cuda-copy. (default = 0)
 \var starpu_conf::disable_asynchronous_opencl_copy
 This flag should be set to 1 to disable
 asynchronous copies between CPUs and OpenCL accelerators.
-This can also be specified with the
-STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY environment
-variable. The AMD implementation of OpenCL is known to fail
+This can also be specified with the environment
+variable \ref STARPU_DISABLE_ASYNCHRONOUS_OPENCL_COPY. The AMD
+implementation of OpenCL is known to fail
 when copying data asynchronously. When using this
 implementation, it is therefore necessary to disable
 asynchronous data transfers. This can also be specified at
 compilation time by giving to the configure script the
-option <c>--disable-asynchronous-opencl-copy</c>. (default
+option \ref disable-asynchronous-opencl-copy. (default
 = 0)
 
 \var starpu_conf::disable_asynchronous_mic_copy
@@ -208,10 +206,10 @@ starpu_initialize() in the same program.
 \ingroup API_Initialization_and_Termination
 This function initializes the conf structure passed as argument with
 the default values. In case some configuration parameters are already
-specified through environment variables, starpu_conf_init initializes
+specified through environment variables, starpu_conf_init() initializes
 the fields of the structure according to the environment variables.
-For instance if STARPU_CALIBRATE is set, its value is put in the
-.calibrate field of the structure passed as argument. Upon successful
+For instance if \ref STARPU_CALIBRATE is set, its value is put in the
+field starpu_conf::calibrate of the structure passed as argument. Upon successful
 completion, this function returns 0. Otherwise, -EINVAL indicates that
 the argument was NULL.
 

+ 1 - 2
doc/doxygen/chapters/api/misc_helpers.doxy

@@ -16,8 +16,7 @@ the case of an asynchronous call, it is possible to synchronize with
 the termination of this operation either by the means of implicit
 dependencies (if enabled) or by calling starpu_task_wait_for_all(). If
 \p callback_func is not NULL, this callback function is executed after
-the handle has been copied, and it is given the pointer \p pointer
-callback_arg as argument.
+the handle has been copied, and it is given the pointer \p callback_arg as argument.
 
 \fn void starpu_execute_on_each_worker(void (*func)(void *), void *arg, uint32_t where)
 \ingroup API_Miscellaneous_Helpers

+ 6 - 6
doc/doxygen/chapters/api/mpi.doxy

@@ -44,7 +44,7 @@ called if StarPU-MPI has been initialized by starpu_mpi_init().
 Retrieve the current amount of communications from the current node in
 the array \p comm_amounts which must have a size greater or equal to
 the world size. Communications statistics must be enabled (see
-STARPU_COMM_STATS).
+\ref STARPU_COMM_STATS).
 
 @name Communication
 \ingroup API_MPI_Support
@@ -148,14 +148,14 @@ requests, \p tag is unlocked.
 Clear the send and receive communication cache for the data
 \p data_handle. The function has to be called synchronously by all the
 MPI nodes. The function does nothing if the cache mechanism is
-disabled (see STARPU_MPI_CACHE).
+disabled (see \ref STARPU_MPI_CACHE).
 
 \fn void starpu_mpi_cache_flush_all_data (MPI_Comm comm)
 \ingroup API_MPI_Support
 Clear the send and receive communication cache for all data. The
 function has to be called synchronously by all the MPI nodes. The
 function does nothing if the cache mechanism is disabled (see
-STARPU_MPI_CACHE).
+\ref STARPU_MPI_CACHE).
 
 @name MPI Insert Task
 \ingroup API_MPI_Support
@@ -207,8 +207,8 @@ The internal algorithm is as follows:
 <li>
         Find out which MPI node is going to execute the codelet.
         <ul>
-            <li>If there is only one node owning data in W mode, it will be selected;
-            <li>If there is several nodes owning data in W node, the one selected will be the one having the least data in R mode so as to minimize the amount of data to be transfered;
+            <li>If there is only one node owning data in ::STARPU_W mode, it will be selected;
+            <li>If there is several nodes owning data in ::STARPU_W node, the one selected will be the one having the least data in R mode so as to minimize the amount of data to be transfered;
             <li>The argument ::STARPU_EXECUTE_ON_NODE followed by an integer can be used to specify the node;
             <li>The argument ::STARPU_EXECUTE_ON_DATA followed by a data handle can be used to specify that the node owing the given data will execute the codelet.
         </ul>
@@ -226,7 +226,7 @@ The internal algorithm is as follows:
 
 The algorithm also includes a communication cache mechanism that
 allows not to send data twice to the same MPI node, unless the data
-has been modified. The cache can be disabled (see STARPU_MPI_CACHE).
+has been modified. The cache can be disabled (see \ref STARPU_MPI_CACHE).
 
 \fn void starpu_mpi_get_data_on_node (MPI_Comm comm, starpu_data_handle_t data_handle, int node)
 \ingroup API_MPI_Support

+ 2 - 3
doc/doxygen/chapters/api/opencl_extensions.doxy

@@ -12,8 +12,7 @@
 \ingroup API_OpenCL_Extensions
 This macro is defined when StarPU has been installed with
 OpenCL support. It should be used in your code to detect the
-availability of OpenCL as shown in Full source code for the 'Scaling a
-Vector' example.
+availability of OpenCL as shown in \ref FullSourceCodeVectorScal.
 
 \struct starpu_opencl_program
 \ingroup API_OpenCL_Extensions
@@ -100,7 +99,7 @@ This function unloads an OpenCL compiled code.
 Store the contents of the file \p source_file_name in the buffer
 \p opencl_program_source. The file \p source_file_name can be located in the
 current directory, or in the directory specified by the environment
-variable STARPU_OPENCL_PROGRAM_DIR (see STARPU_OPENCL_PROGRAM_DIR), or
+variable \ref STARPU_OPENCL_PROGRAM_DIR, or
 in the directory <c>share/starpu/opencl</c> of the installation
 directory of StarPU, or in the source directory of StarPU. When the
 file is found, \p located_file_name is the full name of the file as it

+ 1 - 1
doc/doxygen/chapters/api/performance_model.doxy

@@ -258,7 +258,7 @@ measurement measured, in addition to measurements done by StarPU
 itself. This can be useful when the application already has an
 existing set of measurements done in good conditions, that StarPU
 could benefit from instead of doing on-line measurements. And example
-of use can be see in \ref Performance_model_example.
+of use can be seen in \ref PerformanceModelExample.
 
 \fn double starpu_get_bandwidth_RAM_CUDA(unsigned cudadev)
 \ingroup API_Performance_Model

+ 6 - 6
doc/doxygen/chapters/api/profiling.doxy

@@ -101,8 +101,8 @@ todo
 \fn int starpu_profiling_status_set(int status)
 \ingroup API_Profiling
 This function sets the profiling status. Profiling is activated
-by passing STARPU_PROFILING_ENABLE in status. Passing
-STARPU_PROFILING_DISABLE disables profiling. Calling this function
+by passing \ref STARPU_PROFILING_ENABLE in status. Passing
+\ref STARPU_PROFILING_DISABLE disables profiling. Calling this function
 resets all profiling measurements. When profiling is enabled, the
 field starpu_task::profiling_info points to a valid structure
 starpu_profiling_task_info containing information about the execution
@@ -158,19 +158,19 @@ Converts the given timespec \p ts into microseconds
 \fn void starpu_profiling_bus_helper_display_summary(void)
 \ingroup API_Profiling
 Displays statistics about the bus on stderr. if the environment
-variable STARPU_BUS_STATS is defined. The function is called
+variable \ref STARPU_BUS_STATS is defined. The function is called
 automatically by starpu_shutdown().
 
 \fn void starpu_profiling_worker_helper_display_summary(void)
 \ingroup API_Profiling
 Displays statistics about the workers on stderr if the
-environment variable STARPU_WORKER_STATS is defined. The function is
+environment variable \ref STARPU_WORKER_STATS is defined. The function is
 called automatically by starpu_shutdown().
 
 \fn void starpu_data_display_memory_stats()
 \ingroup API_Profiling
 Display statistics about the current data handles registered
-within StarPU. StarPU must have been configured with the option
-<c>--enable-memory-stats</c> (see \ref Memory_feedback).
+within StarPU. StarPU must have been configured with the configure
+option \ref enable-memory-stats (see \ref MemoryFeedback).
 
 */

+ 1 - 1
doc/doxygen/chapters/api/running_driver.doxy

@@ -13,7 +13,7 @@
 Initialize the given driver, run it until it receives a request to
 terminate, deinitialize it and return 0 on success. It returns
 <c>-EINVAL</c> if <c>d->type</c> is not a valid StarPU device type
-(STARPU_CPU_WORKER, STARPU_CUDA_WORKER or STARPU_OPENCL_WORKER). This
+(::STARPU_CPU_WORKER, ::STARPU_CUDA_WORKER or ::STARPU_OPENCL_WORKER). This
 is the same as using the following functions: calling
 starpu_driver_init(), then calling starpu_driver_run_once() in a loop,
 and eventually starpu_driver_deinit().

+ 5 - 5
doc/doxygen/chapters/api/scheduling_context_hypervisor.doxy

@@ -117,7 +117,7 @@ they should be hidden to the user
 \fn struct starpu_sched_ctx_performance_counters *sc_hypervisor_init(struct sc_hypervisor_policy * policy)
 \ingroup API_Scheduling_Context_Hypervisor
 Initializes the hypervisor to use the strategy provided as parameter
-and creates the performance counters (see \ref Performance_Counters).
+and creates the performance counters (see \ref PerformanceCounters).
 These performance counters represent actually some callbacks that will
 be used by the contexts to notify the information needed by the
 hypervisor.
@@ -145,7 +145,7 @@ hypervisor.
 \ingroup API_Scheduling_Context_Hypervisor
 Register the context to the hypervisor, and indicate the number of
 flops the context will execute (needed for Gflops rate based strategy
-see \ref Resizing_strategies or any other custom strategy needing it, for
+see \ref ResizingStrategies or any other custom strategy needing it, for
 the others we can pass 0.0)
 
 \fn void sc_hypervisor_unregister_ctx (unsigned sched_ctx)
@@ -224,8 +224,8 @@ workers are not allowed to be moved from the context.
 This macro is used when calling sc_hypervisor_ioctl() and must be
 followed by 1 argument (int) that indicated the minimum number of
 tasks that have to be executed before the context could be resized.
-This parameter is ignored for the Application Driven strategy see
-Resizing strategies where the user indicates exactly when the resize
+This parameter is ignored for the Application Driven strategy (see \ref 
+ResizingStrategies) where the user indicates exactly when the resize
 should be done.
 
 \def HYPERVISOR_NEW_WORKERS_MAX_IDLE
@@ -245,7 +245,7 @@ should have such that this configuration should be taken into account.
 \ingroup API_Scheduling_Context_Hypervisor
 
 While Scheduling Context Hypervisor Plugin comes with a variety of
-resizing policies (see \ref Resizing_strategies), it may sometimes be
+resizing policies (see \ref ResizingStrategies), it may sometimes be
 desirable to implement custom policies to address specific problems.
 The API described below allows users to write their own resizing policy.
 

+ 2 - 2
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -83,7 +83,7 @@ execute the tasks submitted to it.
 The return value represents the identifier of the context that has
 just been created. It will be further used to indicate the context the
 tasks will be submitted to. The return value should be at most
-STARPU_NMAX_SCHED_CTXS.
+\ref STARPU_NMAX_SCHED_CTXS.
 
 \fn unsigned starpu_sched_ctx_create_inside_interval(const char *policy_name, const char *sched_name, int min_ncpus, int max_ncpus, int min_ngpus, int max_ngpus, unsigned allow_overlap)
 \ingroup API_Scheduling_Contexts
@@ -98,7 +98,7 @@ workers to the inheritor scheduling context.
 \ingroup API_Scheduling_Contexts
 This function adds dynamically the workers in \p workerids_ctx to the
 context \p sched_ctx_id. The last argument cannot be greater than
-STARPU_NMAX_SCHED_CTXS.
+\ref STARPU_NMAX_SCHED_CTXS.
 
 \fn void starpu_sched_ctx_remove_workers(int *workerids_ctx, int nworkers_ctx, unsigned sched_ctx_id)
 \ingroup API_Scheduling_Contexts

+ 2 - 2
doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -9,7 +9,7 @@
 /*! \defgroup API_Scheduling_Policy Scheduling Policy
 
 \brief TODO. While StarPU comes with a variety of scheduling policies
-(see \ref Task_scheduling_policy), it may sometimes be desirable to
+(see \ref TaskSchedulingPolicy), it may sometimes be desirable to
 implement custom policies to address specific problems. The API
 described below allows users to write their own scheduling policy.
 
@@ -165,7 +165,7 @@ Returns expected conversion time in ms (multiformat interface only)
 
 \fn int starpu_get_prefetch_flag(void)
 \ingroup API_Scheduling_Policy
-Whether STARPU_PREFETCH was set
+Whether \ref STARPU_PREFETCH was set
 
 \fn int starpu_prefetch_task_input_on_node(struct starpu_task *task, unsigned node)
 \ingroup API_Scheduling_Policy

+ 7 - 7
doc/doxygen/chapters/api/standard_memory_library.doxy

@@ -16,13 +16,13 @@ Value passed to the function starpu_malloc_flags() to indicate the memory alloca
 \ingroup API_Standard_Memory_Library
 Value passed to the function starpu_malloc_flags() to indicate
 the memory allocation should be in the limit defined by the
-environment variables <c>STARPU_LIMIT_CUDA_devid_MEM</c>,
-<c>STARPU_LIMIT_CUDA_MEM</c>, <c>STARPU_LIMIT_OPENCL_devid_MEM</c>,
-<c>STARPU_LIMIT_OPENCL_MEM</c> and <c>STARPU_LIMIT_CPU_MEM</c> (see
-Section \ref How_to_limit_memory_per_node).
+environment variables \ref STARPU_LIMIT_CUDA_devid_MEM,
+\ref STARPU_LIMIT_CUDA_MEM, \ref STARPU_LIMIT_OPENCL_devid_MEM,
+\ref STARPU_LIMIT_OPENCL_MEM and \ref STARPU_LIMIT_CPU_MEM (see
+Section \ref HowToLimitMemoryPerNode).
 If no memory is available, it tries to reclaim memory from StarPU.
-Memory allocated this way needs to be freed by calling the
-starpu_free_flags() function with the same flag.
+Memory allocated this way needs to be freed by calling the function
+starpu_free_flags() with the same flag.
 
 \fn int starpu_malloc_flags(void **A, size_t dim, int flags)
 \ingroup API_Standard_Memory_Library
@@ -58,7 +58,7 @@ when allocating the memory.
 \fn ssize_t starpu_memory_get_available(unsigned node)
 \ingroup API_Standard_Memory_Library
 If a memory limit is defined on the given node (see Section \ref
-How_to_limit_memory_per_node), return the amount of available memory
+HowToLimitMemoryPerNode), return the amount of available memory
 on the node. Otherwise return -1.
 
 */

+ 22 - 22
doc/doxygen/chapters/api/workers.doxy

@@ -62,7 +62,7 @@ Intel SCC device
 \ingroup API_Workers_Properties
 This function returns the number of workers (i.e. processing
 units executing StarPU tasks). The returned value should be at most
-STARPU_NMAXWORKERS.
+\ref STARPU_NMAXWORKERS.
 
 \fn int starpu_worker_get_count_by_type(enum starpu_worker_archtype type)
 \ingroup API_Workers_Properties
@@ -73,17 +73,17 @@ type is not valid otherwise.
 \fn unsigned starpu_cpu_worker_get_count(void)
 \ingroup API_Workers_Properties
 This function returns the number of CPUs controlled by StarPU. The
-returned value should be at most STARPU_MAXCPUS.
+returned value should be at most \ref STARPU_MAXCPUS.
 
 \fn unsigned starpu_cuda_worker_get_count(void)
 \ingroup API_Workers_Properties
 This function returns the number of CUDA devices controlled by
-StarPU. The returned value should be at most STARPU_MAXCUDADEVS.
+StarPU. The returned value should be at most \ref STARPU_MAXCUDADEVS.
 
 \fn unsigned starpu_opencl_worker_get_count(void)
 \ingroup API_Workers_Properties
 This function returns the number of OpenCL devices controlled by
-StarPU. The returned value should be at most STARPU_MAXOPENCLDEVS.
+StarPU. The returned value should be at most \ref STARPU_MAXOPENCLDEVS.
 
 \fn int starpu_worker_get_id (void)
 \ingroup API_Workers_Properties
@@ -96,16 +96,16 @@ between 0 and starpu_worker_get_count() - 1.
 \fn int starpu_worker_get_ids_by_type(enum starpu_worker_archtype type, int *workerids, int maxsize)
 \ingroup API_Workers_Properties
 This function gets the list of identifiers of workers with the
-given type. It fills the workerids array with the identifiers of the
+given type. It fills the array \p workerids with the identifiers of the
 workers that have the type indicated in the first argument. The
-maxsize argument indicates the size of the workids array. The returned
+argument \p maxsize indicates the size of the array \p workerids. The returned
 value gives the number of identifiers that were put in the array.
--ERANGE is returned is maxsize is lower than the number of workers
+-ERANGE is returned is \p maxsize is lower than the number of workers
 with the appropriate type: in that case, the array is filled with the
-maxsize first elements. To avoid such overflows, the value of maxsize
-can be chosen by the means of the starpu_worker_get_count_by_type
-function, or by passing a value greater or equal to
-STARPU_NMAXWORKERS.
+\p maxsize first elements. To avoid such overflows, the value of maxsize
+can be chosen by the means of the function
+starpu_worker_get_count_by_type(), or by passing a value greater or
+equal to \ref STARPU_NMAXWORKERS.
 
 \fn int starpu_worker_get_by_type(enum starpu_worker_archtype type, int num)
 \ingroup API_Workers_Properties
@@ -115,8 +115,8 @@ specified type type. If there are no such worker, -1 is returned.
 \fn int starpu_worker_get_by_devid(enum starpu_worker_archtype type, int devid)
 \ingroup API_Workers_Properties
 This returns the identifier of the worker that has the specified type
-type and devid devid (which may not be the n-th, if some devices are
-skipped for instance). If there are no such worker, -1 is returned.
+\p type and device id \p devid (which may not be the n-th, if some
+devices are skipped for instance). If there are no such worker, -1 is returned.
 
 \fn int starpu_worker_get_devid(int id)
 \ingroup API_Workers_Properties
@@ -124,18 +124,18 @@ This function returns the device id of the given worker. The
 worker should be identified with the value returned by the
 starpu_worker_get_id() function. In the case of a CUDA worker, this
 device identifier is the logical device identifier exposed by CUDA
-(used by the cudaGetDevice function for instance). The device
+(used by the function cudaGetDevice() for instance). The device
 identifier of a CPU worker is the logical identifier of the core on
 which the worker was bound; this identifier is either provided by the
-OS or by the hwloc library in case it is available.
+OS or by the library <c>hwloc</c> in case it is available.
 
 \fn enum starpu_worker_archtype starpu_worker_get_type(int id)
 \ingroup API_Workers_Properties
 This function returns the type of processing unit associated to
-a worker. The worker identifier is a value returned by the
-starpu_worker_get_id() function). The returned value indicates the
-architecture of the worker: STARPU_CPU_WORKER for a CPU core,
-STARPU_CUDA_WORKER for a CUDA device, and STARPU_OPENCL_WORKER for a
+a worker. The worker identifier is a value returned by the function
+starpu_worker_get_id()). The returned value indicates the
+architecture of the worker: ::STARPU_CPU_WORKER for a CPU core,
+::STARPU_CUDA_WORKER for a CUDA device, and ::STARPU_OPENCL_WORKER for a
 OpenCL device. The value returned for an invalid identifier is
 unspecified.
 
@@ -145,14 +145,14 @@ This function allows to get the name of a given worker. StarPU
 associates a unique human readable string to each processing unit.
 This function copies at most the maxlen first bytes of the unique
 string associated to a worker identified by its identifier id into the
-dst buffer. The caller is responsible for ensuring that the dst is a
-valid pointer to a buffer of maxlen bytes at least. Calling this
+dst buffer. The caller is responsible for ensuring that \p dst is a
+valid pointer to a buffer of \p maxlen bytes at least. Calling this
 function on an invalid identifier results in an unspecified behaviour.
 
 \fn unsigned starpu_worker_get_memory_node(unsigned workerid)
 \ingroup API_Workers_Properties
 This function returns the identifier of the memory node
-associated to the worker identified by workerid.
+associated to the worker identified by \p workerid.
 
 \fn enum starpu_node_kind starpu_node_get_kind(unsigned node)
 \ingroup API_Workers_Properties

+ 12 - 12
doc/doxygen/chapters/configure_options.doxy

@@ -75,7 +75,7 @@ Enable some exhaustive checks which take a really long time.
 <dd>
 \anchor with-hwloc
 \addindex __configure__--with-hwloc
-Specify hwloc should be used by StarPU. hwloc should be found by the
+Specify <c>hwloc</c> should be used by StarPU. <c>hwloc</c> should be found by the
 means of the tool <c>pkg-config</c>.
 </dd>
 
@@ -83,7 +83,7 @@ means of the tool <c>pkg-config</c>.
 <dd>
 \anchor with-hwloc
 \addindex __configure__--with-hwloc
-Specify hwloc should be used by StarPU. hwloc should be found in the
+Specify <c>hwloc</c> should be used by StarPU. <c>hwloc</c> should be found in the
 directory specified by <c>prefix</c>
 </dd>
 
@@ -91,7 +91,7 @@ directory specified by <c>prefix</c>
 <dd>
 \anchor without-hwloc
 \addindex __configure__--without-hwloc
-Specify hwloc should not be used by StarPU.
+Specify <c>hwloc</c> should not be used by StarPU.
 </dd>
 
 <dt>--disable-build-doc</dt>
@@ -282,7 +282,7 @@ it is therefore necessary to disable asynchronous data transfers.
 <dd>
 \anchor disable-socl
 \addindex __configure__--disable-socl
-Disable the SOCL extension (\ref SOCL_OpenCL_Extensions).  By
+Disable the SOCL extension (\ref SOCLOpenclExtensions).  By
 default, it is enabled when an OpenCL implementation is found.
 </dd>
 
@@ -290,7 +290,7 @@ default, it is enabled when an OpenCL implementation is found.
 <dd>
 \anchor disable-starpu-top
 \addindex __configure__--disable-starpu-top
-Disable the StarPU-Top interface (\ref StarPU-Top).  By default, it
+Disable the StarPU-Top interface (\ref StarPU-TopInterface).  By default, it
 is enabled when the required dependencies are found.
 </dd>
 
@@ -298,7 +298,7 @@ is enabled when the required dependencies are found.
 <dd>
 \anchor disable-gcc-extensions
 \addindex __configure__--disable-gcc-extensions
-Disable the GCC plug-in (\ref C_Extensions).  By default, it is
+Disable the GCC plug-in (\ref cExtensions).  By default, it is
 enabled when the GCC compiler provides a plug-in support.
 </dd>
 
@@ -307,7 +307,7 @@ enabled when the GCC compiler provides a plug-in support.
 \anchor with-mpicc
 \addindex __configure__--with-mpicc
 Use the compiler <c>mpicc</c> at <c>path</c>, for StarPU-MPI.
-(\ref StarPU_MPI_support).
+(\ref MPISupport).
 </dd>
 
 <dt>--enable-mpi-progression-hook</dt>
@@ -340,7 +340,7 @@ Enable performance model debugging.
 \anchor enable-stats
 \addindex __configure__--enable-stats
 (see ../../src/datawizard/datastats.c)
-Enable gathering of various data statistics (\ref Data_statistics).
+Enable gathering of various data statistics (\ref DataStatistics).
 </dd>
 
 <dt>--enable-maxbuffers</dt>
@@ -381,7 +381,7 @@ library has to be 'atlas' or 'goto'.
 <dd>
 \anchor disable-starpufft
 \addindex __configure__--disable-starpufft
-Disable the build of libstarpufft, even if fftw or cuFFT is available.
+Disable the build of libstarpufft, even if <c>fftw</c> or <c>cuFFT</c> is available.
 </dd>
 
 <dt>--with-magma=<c>prefix</c></dt>
@@ -399,7 +399,7 @@ contain <c>include/magmablas.h</c>.
 Search for FxT under <c>prefix</c>.
 FxT (http://savannah.nongnu.org/projects/fkt) is used to generate
 traces of scheduling events, which can then be rendered them using ViTE
-(\ref off-line_performance_feedback).  <c>prefix</c> should
+(\ref Off-linePerformanceFeedback).  <c>prefix</c> should
 notably contain <c>include/fxt/fxt.h</c>.
 </dd>
 
@@ -456,7 +456,7 @@ Disable the build of examples.
 <dd>
 \anchor enable-sc-hypervisor
 \addindex __configure__--enable-sc-hypervisor
-Enable the Scheduling Context Hypervisor plugin(\ref Scheduling_Context_Hypervisor).
+Enable the Scheduling Context Hypervisor plugin(\ref SchedulingContextHypervisor).
 By default, it is disabled.
 </dd>
 
@@ -464,7 +464,7 @@ By default, it is disabled.
 <dd>
 \anchor enable-memory-stats
 \addindex __configure__--enable-memory-stats
-Enable memory statistics (\ref Memory_feedback).
+Enable memory statistics (\ref MemoryFeedback).
 </dd>
 
 <dt>--enable-simgrid</dt>

+ 11 - 11
doc/doxygen/chapters/environment_variables.doxy

@@ -11,7 +11,7 @@
 The behavior of the StarPU library and tools may be tuned thanks to
 the following environment variables.
 
-\section ConfiguringWorkers ConfiguringWorkers
+\section ConfiguringWorkers Configuring Workers
 
 <dl>
 
@@ -169,7 +169,7 @@ number of CPU workers in the system)
 \addindex __env__STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
 Let the user decide how many elements are allowed between combined workers
 created from hwloc information. For instance, in the case of sockets with 6
-cores without shared L2 caches, if \ref SYNTHESIZE_ARITY_COMBINED_WORKER is
+cores without shared L2 caches, if \ref STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER is
 set to 6, no combined worker will be synthesized beyond one for the socket
 and one per core. If it is set to 3, 3 intermediate combined workers will be
 synthesized, to divide the socket cores into 3 chunks of 2 cores. If it set to
@@ -294,21 +294,21 @@ the coefficient to be applied to it before adding it to the computation part.
 <dd>
 \anchor STARPU_SCHED_GAMMA
 \addindex __env__STARPU_SCHED_GAMMA
-Define the execution time penalty of a joule (\ref Power-based_scheduling).
+Define the execution time penalty of a joule (\ref Power-basedScheduling).
 </dd>
 
 <dt>STARPU_IDLE_POWER</dt>
 <dd>
 \anchor STARPU_IDLE_POWER
 \addindex __env__STARPU_IDLE_POWER
-Define the idle power of the machine (\ref Power-based_scheduling).
+Define the idle power of the machine (\ref Power-basedScheduling).
 </dd>
 
 <dt>STARPU_PROFILING</dt>
 <dd>
 \anchor STARPU_PROFILING
 \addindex __env__STARPU_PROFILING
-Enable on-line performance monitoring (\ref Enabling_on-line_performance_monitoring).
+Enable on-line performance monitoring (\ref EnablingOn-linePerformanceMonitoring).
 </dd>
 
 </dl>
@@ -323,14 +323,14 @@ Enable on-line performance monitoring (\ref Enabling_on-line_performance_monitor
 \addindex __env__SOCL_OCL_LIB_OPENCL
 THE SOCL test suite is only run when the environment variable \ref
 SOCL_OCL_LIB_OPENCL is defined. It should contain the location
-of the libOpenCL.so file of the OCL ICD implementation.
+of the file <c>libOpenCL.so</c> of the OCL ICD implementation.
 </dd>
 
 <dt>STARPU_COMM_STATS</dt>
 <dd>
 \anchor STARPU_COMM_STATS
 \addindex __env__STARPU_COMM_STATS
-Communication statistics for starpumpi (\ref StarPU_MPI_support)
+Communication statistics for starpumpi (\ref MPISupport)
 will be enabled when the environment variable \ref STARPU_COMM_STATS
 is defined to an value other than 0.
 </dd>
@@ -339,7 +339,7 @@ is defined to an value other than 0.
 <dd>
 \anchor STARPU_MPI_CACHE
 \addindex __env__STARPU_MPI_CACHE
-Communication cache for starpumpi (\ref StarPU_MPI_support) will be
+Communication cache for starpumpi (\ref MPISupport) will be
 disabled when the environment variable \ref STARPU_MPI_CACHE is set
 to 0. It is enabled by default or for any other values of the variable
 \ref STARPU_MPI_CACHE.
@@ -472,7 +472,7 @@ generate a Paje trace when starpu_shutdown() is called.
 \anchor STARPU_MEMORY_STATS
 \addindex __env__STARPU_MEMORY_STATS
 When set to 0, disable the display of memory statistics on data which
-have not been unregistered at the end of the execution (\ref Memory_feedback).
+have not been unregistered at the end of the execution (\ref MemoryFeedback).
 </dd>
 
 <dt>STARPU_BUS_STATS</dt>
@@ -490,7 +490,7 @@ starpu_shutdown() (\ref Profiling).
 When defined, statistics about the workers will be displayed when calling
 starpu_shutdown() (\ref Profiling). When combined with the
 environment variable \ref STARPU_PROFILING, it displays the power
-consumption (\ref Power-based_scheduling).
+consumption (\ref Power-basedScheduling).
 </dd>
 
 <dt>STARPU_STATS</dt>
@@ -498,7 +498,7 @@ consumption (\ref Power-based_scheduling).
 \anchor STARPU_STATS
 \addindex __env__STARPU_STATS
 When set to 0, data statistics will not be displayed at the
-end of the execution of an application (\ref Data_statistics).
+end of the execution of an application (\ref DataStatistics).
 </dd>
 
 </dl>