From a4db97c213bc2de4e6bf869a8bb5be67a5bb1e3b Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Tue, 3 Jun 2008 16:44:40 +0000 Subject: [PATCH] More man pages fixes from our Debian Open MPI package maintainer friends. Woo hoo! This commit was SVN r18559. --- ompi/mpi/man/man3/MPI_Bcast.3 | 2 +- ompi/mpi/man/man3/MPI_Type_create_darray.3 | 2 +- ompi/mpi/man/man3/MPI_Wait.3 | 3 +-- orte/tools/orterun/orterun.1 | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/ompi/mpi/man/man3/MPI_Bcast.3 b/ompi/mpi/man/man3/MPI_Bcast.3 index f81264a873..9ef4388f56 100644 --- a/ompi/mpi/man/man3/MPI_Bcast.3 +++ b/ompi/mpi/man/man3/MPI_Bcast.3 @@ -26,7 +26,7 @@ void MPI::Comm::Bcast(void* \fIbuffer\fP, int \fIcount\fP, const MPI::Datatype& \fIdatatype\fP, int \fIroot\fP) const = 0 .SH INPUT/OUTPUT PARAMETERS -.fR +.ft R .TP 1i buffer Starting address of buffer (choice). diff --git a/ompi/mpi/man/man3/MPI_Type_create_darray.3 b/ompi/mpi/man/man3/MPI_Type_create_darray.3 index 3b2504d66b..7f79bc296b 100644 --- a/ompi/mpi/man/man3/MPI_Type_create_darray.3 +++ b/ompi/mpi/man/man3/MPI_Type_create_darray.3 @@ -98,7 +98,7 @@ Each dimension of the array can be distributed in one of three ways: - MPI_DISTRIBUTE_NONE - Dimension not distributed. .fi .sp -The constant MPI_DISTRIBUTE_DFLT_DARG specifies a default distribution argument. The distribution argument for a dimension that is not distributed is ignored. For any dimension \fIi\fP in which the distribution is MPI_DISTRIBUTE_BLOCK, it erroneous to specify \fIarray_of_dargs[i]\fP \fI\*\fP \fIarray_of_psizes[i]\fP < \fIarray_of_gsizes[i]\fP. +The constant MPI_DISTRIBUTE_DFLT_DARG specifies a default distribution argument. The distribution argument for a dimension that is not distributed is ignored. For any dimension \fIi\fP in which the distribution is MPI_DISTRIBUTE_BLOCK, it erroneous to specify \fIarray_of_dargs[i]\fP \fI*\fP \fIarray_of_psizes[i]\fP < \fIarray_of_gsizes[i]\fP. .sp For example, the HPF layout ARRAY(CYCLIC(15)) corresponds to MPI_DISTRIBUTE_CYCLIC with a distribution argument of 15, and the HPF layout ARRAY(BLOCK) corresponds to MPI_DISTRIBUTE_BLOCK with a distribution argument of MPI_DISTRIBUTE_DFLT_DARG. .sp diff --git a/ompi/mpi/man/man3/MPI_Wait.3 b/ompi/mpi/man/man3/MPI_Wait.3 index 96d02ade44..e960001ded 100644 --- a/ompi/mpi/man/man3/MPI_Wait.3 +++ b/ompi/mpi/man/man3/MPI_Wait.3 @@ -50,7 +50,7 @@ If your application does not need to examine the \fIstatus\fP field, you can sav .sp One is allowed to call MPI_Wait with a null or inactive request argument. In this case the operation returns immediately with empty status. -.NOTES +.SH NOTES Successful return of MPI_Wait after an MPI_Ibsend implies that the user send buffer can be reused i.e., data has been sent out or copied into a buffer attached with MPI_Buffer_attach. Note that, at this point, we can no longer cancel the send (for more information, see Section 3.8 of the MPI-1 Standard, "Probe and Cancel"). If a matching receive is never posted, then the buffer cannot be freed. This runs somewhat counter to the stated goal of MPI_Cancel (always being able to free program space that was committed to the communication subsystem). .sp Example: Simple usage of nonblocking operations and MPI_Wait. @@ -66,7 +66,6 @@ Example: Simple usage of nonblocking operations and MPI_Wait. **** do some computation **** CALL MPI_WAIT(request, status, ierr) END IF -.ni .SH ERRORS Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object. diff --git a/orte/tools/orterun/orterun.1 b/orte/tools/orterun/orterun.1 index 95351f3510..5d44f3c39a 100644 --- a/orte/tools/orterun/orterun.1 +++ b/orte/tools/orterun/orterun.1 @@ -455,7 +455,7 @@ nodes. .SS Specifying Hosts . Hosts can be specified in a number of ways. The most common of which is in a -'hostfile' or 'machinefile'. If our hostfile contain the following information: +\&'hostfile' or 'machinefile'. If our hostfile contain the following information: . .