Browse Source

doc: move function definition to api.texi

Nathalie Furmento 12 years ago
parent
commit
000038d970
2 changed files with 13 additions and 10 deletions
  1. 10 0
      doc/chapters/api.texi
  2. 3 10
      doc/chapters/mpi-support.texi

+ 10 - 0
doc/chapters/api.texi

@@ -3265,6 +3265,16 @@ to the world size. Communications statistics must be enabled
 (@pxref{STARPU_COMM_STATS}).
 @end deftypefun
 
+@deftypefun void starpu_mpi_set_communication_tag (int @var{tag})
+@anchor{starpu_mpi_set_communication_tag}
+Tell StarPU-MPI which MPI tag to use for all its communications.
+@end deftypefun
+
+@deftypefun int starpu_mpi_get_communication_tag (void)
+@anchor{starpu_mpi_get_communication_tag}
+Returns the MPI tag which will be used for all StarPU-MPI communications.
+@end deftypefun
+
 @node Communication
 @subsection Communication
 

+ 3 - 10
doc/chapters/mpi-support.texi

@@ -152,16 +152,9 @@ the list of the ready requests if it is a send request, or in an
 hashmap if it is a receive request.
 
 Internally, all MPI communications submitted by StarPU uses a unique
-tag called starpu_mpi_tag, which can be accessed with getter/setter
-functions.
-
-@deftypefun void starpu_mpi_set_starpu_mpi_tag (int @var{tag})
-Tell StarPU-MPI which MPI tag to use for all its communications.
-@end deftypefun
-
-@deftypefun int starpu_mpi_get_starpu_mpi_tag (void)
-Returns the MPI tag which will be used for all StarPU-MPI communications.
-@end deftypefun
+tag which has a default value, and can be accessed with the functions
+@ref{starpu_mpi_get_communication_tag} and
+@ref{starpu_mpi_set_communication_tag}.
 
 The matching of tags with corresponding requests is done into StarPU-MPI. 
 To handle this, any communication is a double-communication based on a