Browse Source

doc: add missing macros

Nathalie Furmento 13 years ago
parent
commit
ab322b8dd7
2 changed files with 28 additions and 0 deletions
  1. 16 0
      doc/chapters/basic-api.texi
  2. 12 0
      doc/chapters/mpi-support.texi

+ 16 - 0
doc/chapters/basic-api.texi

@@ -1194,6 +1194,22 @@ worker size that StarPU will use to execute parallel tasks for this codelet.
 @end table
 @end deftp
 
+@defmac STARPU_MULTIPLE_CPU_IMPLEMENTATIONS
+todo
+@end defmac
+
+@defmac STARPU_MULTIPLE_CUDA_IMPLEMENTATIONS
+todo
+@end defmac
+
+@defmac STARPU_MULTIPLE_OPENCL_IMPLEMENTATIONS
+todo
+@end defmac
+
+@defmac STARPU_MULTIPLE_GORDON_IMPLEMENTATIONS
+todo
+@end defmac
+
 @deftp {Data Type} {enum starpu_task_status}
 todo
 @end deftp

+ 12 - 0
doc/chapters/mpi-support.texi

@@ -224,6 +224,18 @@ to it.
 Returns the last value set by @code{starpu_data_set_rank}.
 @end deftypefun
 
+@defmac STARPU_EXECUTE_ON_NODE
+this macro is used when calling @code{starpu_mpi_insert_task}, and
+must be followed by a integer value which specified the node on which
+to execute the codelet.
+@end defmac
+
+@defmac STARPU_EXECUTE_ON_DATA
+this macro is used when calling @code{starpu_mpi_insert_task}, and
+must be followed by a data handle to specify that the node owning the
+given data will execute the codelet.
+@end defmac
+
 @deftypefun int starpu_mpi_insert_task (MPI_Comm @var{comm}, struct starpu_codelet *@var{codelet}, ...)
 Create and submit a task corresponding to @var{codelet} with the following
 arguments.  The argument list must be zero-terminated.