[mpich2-commits] r8062 - in mpich2/trunk/src/mpi: datatype topo

[gropp at mcs.anl.gov]

Author: gropp
Date: 2011-02-26 10:47:10 -0600 (Sat, 26 Feb 2011)
New Revision: 8062

Modified:
   mpich2/trunk/src/mpi/datatype/pack.c
   mpich2/trunk/src/mpi/datatype/unpack.c
   mpich2/trunk/src/mpi/topo/dist_gr_create.c
   mpich2/trunk/src/mpi/topo/dist_gr_create_adj.c
Log:
Minor corrections to the comments that are used to produce the man pages

Modified: mpich2/trunk/src/mpi/datatype/pack.c
===================================================================
--- mpich2/trunk/src/mpi/datatype/pack.c	2011-02-26 05:02:31 UTC (rev 8061)
+++ mpich2/trunk/src/mpi/datatype/pack.c	2011-02-26 16:47:10 UTC (rev 8062)
@@ -112,15 +112,19 @@
 /*@
     MPI_Pack - Packs a datatype into contiguous memory
 
-   Arguments:
-+  void *inbuf - input buffer
-.  int incount - input count
-.  MPI_Datatype datatype - datatype
-.  void *outbuf - output buffer
-.  int outcount - output count
-.  int *position - position
--  MPI_Commm comm - communicator
+   Input Parameters:
++  inbuf - input buffer start (choice)
+.  incount - number of input data items (non-negative integer)
+.  datatype - datatype of each input data item (handle)
+.  outcount - output buffer size, in bytes (non-negative integer)
+-  comm - communicator for packed message (handle)
 
+  Output Parameter:
+.  outbuf - output buffer start (choice)
+
+  Input/Output Parameter:
+.  position - current position in buffer, in bytes (integer)
+
   Notes (from the specifications):
 
   The input value of position is the first location in the output buffer to be
@@ -135,6 +139,8 @@
 
 .N Errors
 .N MPI_SUCCESS
+.N MPI_ERR_ARG
+.N MPI_ERR_OTHER
 @*/
 int MPI_Pack(void *inbuf,
 	     int incount,

Modified: mpich2/trunk/src/mpi/datatype/unpack.c
===================================================================
--- mpich2/trunk/src/mpi/datatype/unpack.c	2011-02-26 05:02:31 UTC (rev 8061)
+++ mpich2/trunk/src/mpi/datatype/unpack.c	2011-02-26 16:47:10 UTC (rev 8062)
@@ -108,7 +108,6 @@
 Input Parameters:
 + inbuf - input buffer start (choice)
 . insize - size of input buffer, in bytes (integer)
-. position - current position in bytes (integer)
 . outcount - number of items to be unpacked (integer)
 . datatype - datatype of each output data item (handle)
 - comm - communicator for packed message (handle)
@@ -116,6 +115,10 @@
 Output Parameter:
 . outbuf - output buffer start (choice)
 
+Inout/Output Parameter:
+. position - current position in bytes (integer)
+
+
 .N ThreadSafe
 
 .N Fortran

Modified: mpich2/trunk/src/mpi/topo/dist_gr_create.c
===================================================================
--- mpich2/trunk/src/mpi/topo/dist_gr_create.c	2011-02-26 05:02:31 UTC (rev 8061)
+++ mpich2/trunk/src/mpi/topo/dist_gr_create.c	2011-02-26 16:47:10 UTC (rev 8062)
@@ -38,11 +38,16 @@
 
 Input Parameters:
 + comm_old - input communicator (handle)
-. n - number of source nodes for which this process specifies edges (non-negative integer)
-. sources - array containing the n source nodes for which this process specifies edges (array of non-negative integers)
-. degrees - array specifying the number of destinations for each source node in the source node array (array of non-negative integers)
-. destinations - destination nodes for the source nodes in the source node array (array of non-negative integers)
-. weights - weights for source to destination edges (array of non-negative integers)
+. n - number of source nodes for which this process specifies edges 
+  (non-negative integer)
+. sources - array containing the n source nodes for which this process 
+  specifies edges (array of non-negative integers)
+. degrees - array specifying the number of destinations for each source node 
+  in the source node array (array of non-negative integers)
+. destinations - destination nodes for the source nodes in the source node 
+  array (array of non-negative integers)
+. weights - weights for source to destination edges (array of non-negative 
+  integers or MPI_UNWEIGHTED)
 . info - hints on optimization and interpretation of weights (handle)
 - reorder - the process may be reordered (true) or not (false) (logical)
 
@@ -55,6 +60,8 @@
 
 .N Errors
 .N MPI_SUCCESS
+.N MPI_ERR_ARG
+.N MPI_ERR_OTHER
 @*/
 int MPI_Dist_graph_create(MPI_Comm comm_old, int n, int sources[],
                           int degrees[], int destinations[], int weights[],

Modified: mpich2/trunk/src/mpi/topo/dist_gr_create_adj.c
===================================================================
--- mpich2/trunk/src/mpi/topo/dist_gr_create_adj.c	2011-02-26 05:02:31 UTC (rev 8061)
+++ mpich2/trunk/src/mpi/topo/dist_gr_create_adj.c	2011-02-26 16:47:10 UTC (rev 8062)
@@ -41,11 +41,12 @@
 . sources - ranks of processes for which the calling process is a
             destination (array of non-negative integers)
 . sourceweights - weights of the edges into the calling
-                  process (array of non-negative integers)
+                  process (array of non-negative integers or MPI_UNWEIGHTED)
 . outdegree - size of destinations and destweights arrays (non-negative integer)
 . destinations - ranks of processes for which the calling process is a
                  source (array of non-negative integers)
-. destweights - weights of the edges out of the calling process (array of non-negative integers)
+. destweights - weights of the edges out of the calling process 
+                (array of non-negative integers or MPI_UNWEIGHTED)
 . info - hints on optimization and interpretation of weights (handle)
 - reorder - the ranks may be reordered (true) or not (false) (logical)
 
@@ -58,8 +59,8 @@
 
 .N Errors
 .N MPI_SUCCESS
-.N MPI_ERR_TOPOLOGY
 .N MPI_ERR_ARG
+.N MPI_ERR_OTHER
 @*/
 int MPI_Dist_graph_create_adjacent(MPI_Comm comm_old,
                                    int indegree, int sources[], int sourceweights[],