Quellcode durchsuchen

fix warnings when generating doc

Corentin Salingue vor 8 Jahren
Ursprung
Commit
245611f465

+ 2 - 1
doc/doxygen/Makefile.am

@@ -122,7 +122,8 @@ chapters =	\
 	chapters/api/toolbox.doxy \
 	chapters/api/sc_hypervisor/sc_hypervisor.doxy \
 	chapters/api/sc_hypervisor/sc_hypervisor_usage.doxy \
-	chapters/api/modularized_scheduler.doxy
+	chapters/api/modularized_scheduler.doxy \
+	chapters/api/clustering_machine.doxy
 
 starpu_config.h: $(top_srcdir)/include/starpu_config.h.in
 	@$(SED) 's/#undef \(.*\)/#define \1 1/' $< > $@

+ 3 - 3
doc/doxygen/chapters/410_mpi_support.doxy

@@ -742,12 +742,12 @@ By default, one core is dedicated on the master to manage the entire set of slav
 has a good multiple threads support, you can use <c>--with-mpi-master-slave-multiple-thread</c> to
 dedicate one core per slave.
 
-If you want to chose the number of cores on the slave device, use the <c>STARPU_NMPIMSTHREADS=<number></c>
-with <c><number></c> is the number of cores wanted. The default value is all the slave's cores. To select
+If you want to chose the number of cores on the slave device, use the <c>STARPU_NMPIMSTHREADS=\<number\></c>
+with <c>\<number\></c> is the number of cores wanted. The default value is all the slave's cores. To select
 the number of slaves nodes, change the <c>-n</c> parameter when executing the application with mpirun
 or mpiexec.
 
 The node chosen by default is the with the MPI rank 0. To modify this, use the environment variable
-<c>STARPU_MPI_MASTER_NODE=<number></c> with <c><number></c> is the MPI rank wanted.
+<c>STARPU_MPI_MASTER_NODE=\<number\></c> with <c>\<number\></c> is the MPI rank wanted.
 
 */

+ 13 - 0
doc/doxygen/chapters/api/clustering_machine.doxy

@@ -0,0 +1,13 @@
+/*
+ * This file is part of the StarPU Handbook.
+ * Copyright (C) 2017  Inria
+ * See the file version.doxy for copying conditions.
+ */
+
+/*! \defgroup API_Clustering_Machine Clustering Machine
+
+\def STARPU_CLUSTER_AWAKE_WORKERS
+\ingroup API_Clustering_Machine
+TODO
+
+*/

+ 5 - 0
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -97,6 +97,11 @@ minimum scheduler priority value.
 This macro is used when calling starpu_sched_ctx_create() to specify a
 maximum scheduler priority value.
 
+\def STARPU_SCHED_CTX_AWAKE_WORKERS
+\ingroup API_Scheduling_Contexts
+This macro is used when calling starpu_sched_ctx_create() to specify a
+pointer to a scheduling policy
+
 \def STARPU_SCHED_CTX_POLICY_INIT
 \ingroup API_Scheduling_Contexts
 This macro is used when calling starpu_sched_ctx_create() to specify a

+ 2 - 1
include/starpu_stdlib.h

@@ -57,7 +57,8 @@ void starpu_memory_wait_available(unsigned node, size_t size);
  *
  * @param size amount of memory to allocate
  * @param node node where the memory is to be allocated
- * @return 1 if the given amount of memory was allocated on the given node
+ * @param flags to set the behavior of the function : STARPU_MEMORY_WAIT (wait until memory space will be available), STARPU_MEMORY_OVERFLOW (overflow the memory space)
+ * @return 0 if the given amount of memory was allocated on the given node, -ENOMEM else
  */
 int starpu_memory_allocate(unsigned node, size_t size, int flags);