doc: add missing stuff

doc/doxygen/chapters/450_native_fortran_support.doxy

@@ -25,7 +25,7 @@ Every symbol of the Native Fortran support API is prefixed by
 
 Note: Mixing uses of <c>fstarpu_</c> and <c>starpu_</c>
 symbols in the same Fortran code has unspecified behaviour.
-See \ref APIMIX for a discussion about valid and unspecified
+See \ref NFAPIMIX for a discussion about valid and unspecified
 combinations.
 
 \section NFImplementation Implementation Details and Specificities
@@ -40,7 +40,7 @@ standard. It has currently been tested successfully with GNU GFortran 4.9,
 GFortran 5.x, GFortran 6.x and the Intel Fortran Compiler >= 2016. It is known
 not to work with GNU GFortran < 4.9, Intel Fortran Compiler < 2016.
 
-See Section \ref OldFortran on information on how to write StarPU
+See Section \ref NFOldFortran on information on how to write StarPU
 Fortran code with older compilers.
 
 \subsection NFConfiguration Configuration

doc/doxygen/chapters/501_environment_variables.doxy

@@ -757,6 +757,13 @@ and allows studying scheduling overhead of the runtime system. However,
 it also makes simulation non-deterministic.
 </dd>
 
+<dt>STARPU_SINK</dt>
+<dd>
+\anchor STARPU_SINK
+\addindex __env__STARPU_SINK
+Variable defined by StarPU when running MPI Xeon PHI on the sink.
+</dd>
+
 </dl>
 
 \section MiscellaneousAndDebug Miscellaneous And Debug

doc/doxygen/chapters/510_configure_options.doxy

@@ -726,12 +726,19 @@ exploring various execution paths.
 <dd>
 \anchor enable-calibration-heuristic
 \addindex __configure__--enable-calibration-heuristic
-Allows to set the maximum authorized percentage of deviation
+Allow to set the maximum authorized percentage of deviation
 for the history-based calibrator of StarPU. A correct value
 of this parameter must be in [0..100]. The default value of
 this parameter is 10. Experimental.
 </dd>
 
+<dt>--disable-mlr</dt>
+<dd>
+\anchor disable-mlr
+\addindex __configure__--disable-mlr
+Allow to disable multiple linear regression models (see \ref PerformanceModelExample)
+</dd>
+
 </dl>
 
 */

doc/doxygen/doxygen-config.cfg.in

@@ -17,7 +17,6 @@
 #
 INPUT                  = @top_srcdir@/doc/doxygen/chapters \
 		       	 @top_srcdir@/doc/doxygen/chapters/api \
-		       	 @top_srcdir@/doc/doxygen/chapters/api/sc_hypervisor \
                          @top_builddir@/doc/doxygen/starpu_config.h \
 			 @top_srcdir@/include/starpu_bitmap.h \
 	 		 @top_srcdir@/include/starpu_bound.h \

include/starpu_clusters.h

@@ -34,21 +34,73 @@ extern "C"
    @{
  */
 
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_MIN_NB			(1<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_MAX_NB			(2<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_NB			(3<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_PREFERE_MIN		(4<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_KEEP_HOMOGENEOUS		(5<<STARPU_MODE_SHIFT)
 
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_POLICY_NAME		(6<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_POLICY_STRUCT		(7<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_CREATE_FUNC		(8<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_CREATE_FUNC_ARG		(9<<STARPU_MODE_SHIFT)
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_TYPE			(10<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_AWAKE_WORKERS		(11<<STARPU_MODE_SHIFT)
 
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_PARTITION_ONE		(12<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_NEW			(13<<STARPU_MODE_SHIFT)
+
+/**
+   Used when calling starpu_cluster_machine
+ */
 #define STARPU_CLUSTER_NCORES			(14<<STARPU_MODE_SHIFT)
 
 /**

include/starpu_openmp.h

@@ -27,7 +27,7 @@
 
 #if defined STARPU_OPENMP
 /**
-   Opaque Simple Lock object (\ref SimpleLock) for inter-task
+   Opaque Simple Lock object (\anchor SimpleLock) for inter-task
    synchronization operations.
    \sa starpu_omp_init_lock()
    \sa starpu_omp_destroy_lock()
@@ -38,7 +38,7 @@
 typedef struct { void *internal; /**< opaque pointer for internal use */ } starpu_omp_lock_t;
 
 /**
-   Opaque Nestable Lock object (\ref NestableLock) for inter-task
+   Opaque Nestable Lock object (\anchor NestableLock) for inter-task
    synchronization operations.
    \sa starpu_omp_init_nest_lock()
    \sa starpu_omp_destroy_nest_lock()
@@ -50,7 +50,7 @@ typedef struct { void *internal; /**< opaque pointer for internal use */  } star
 
 /**
    Set of constants for selecting the for loop iteration scheduling
-   algorithm (\ref OMPFor) as defined by the OpenMP specification.
+   algorithm (\anchor OMPFor) as defined by the OpenMP specification.
    \sa starpu_omp_for()
    \sa starpu_omp_for_inline_first()
    \sa starpu_omp_for_inline_next()

include/starpu_task_util.h

@@ -106,6 +106,9 @@ extern "C"
 */
 #define STARPU_TAG               (10<<STARPU_MODE_SHIFT)
 
+/**
+   Used when calling starpu_task_insert(), must be followed by a tag.
+*/
 #define STARPU_HYPERVISOR_TAG	 (11<<STARPU_MODE_SHIFT)
 
 /**

mpi/include/starpu_mpi.h

@@ -409,6 +409,7 @@ int starpu_mpi_cached_send(starpu_data_handle_t data_handle, int dest);
 
 /**
    @name MPI Insert Task
+   \anchor MPIInsertTask
    @{
 */
 
@@ -615,7 +616,15 @@ void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new
    @{
 */
 
+
+/**
+   Define the current policy
+ */
 #define STARPU_MPI_NODE_SELECTION_CURRENT_POLICY -1
+/**
+   Define the policy in which the selected node is the one having the
+   most data in ::STARPU_R mode
+*/
 #define STARPU_MPI_NODE_SELECTION_MOST_R_DATA    0
 
 typedef int (*starpu_mpi_select_node_policy_func_t)(int me, int nb_nodes, struct starpu_data_descr *descr, int nb_data);