Skip to content

Commit ca4b709

Browse files
gpaulsengpaulsen
committed
Revert "man: remove man pages of removed MPI1 subroutines"
This reverts commit 26c1b83. Signed-off-by: Geoffrey Paulsen <[email protected]>
1 parent ed9a670 commit ca4b709

11 files changed

+909
-0
lines changed

‎ompi/mpi/man/man3/MPI_Address.3in

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
3+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
4+
.\" Copyright (c) 1996 Thinking Machines Corporation
5+
.\" $COPYRIGHT$
6+
.TH MPI_Address 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
7+
.SH NAME
8+
\fBMPI_Address\fP \- Gets the address of a location in memory -- use of this routine is deprecated.
9+
10+
.SH SYNTAX
11+
.ft R
12+
.SH C Syntax
13+
.nf
14+
#include <mpi.h>
15+
int MPI_Address(void *\fIlocation\fP, MPI_Aint\fP *address\fP)
16+
17+
.fi
18+
.SH Fortran Syntax
19+
.nf
20+
INCLUDE 'mpif.h'
21+
MPI_ADDRESS(\fILOCATION\fP,\fI ADDRESS\fP,\fI IERROR\fP)
22+
<type> \fILOCATION\fP (*)
23+
INTEGER \fIADDRESS\fP,\fI IERROR\fP
24+
25+
26+
.fi
27+
.SH INPUT PARAMETER
28+
.ft R
29+
.TP 1i
30+
location
31+
Location in caller memory (choice).
32+
33+
.SH OUTPUT PARAMETERS
34+
.ft R
35+
.TP 1i
36+
address
37+
Address of location (integer).
38+
.ft R
39+
.TP 1i
40+
IERROR
41+
Fortran only: Error status (integer).
42+
43+
.SH DESCRIPTION
44+
.ft R
45+
Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Get_address instead.
46+
.sp
47+
This deprecated routine is not available in C++.
48+
.sp
49+
The address of a location in memory can be found by invoking this function. Returns the (byte) address of location.
50+
.sp
51+
Example: Using MPI_Address for an array.
52+
.sp
53+
.nf
54+
REAL A(100,100)
55+
.fi
56+
.br
57+
INTEGER I1, I2, DIFF
58+
.br
59+
CALL MPI_ADDRESS(A(1,1), I1, IERROR)
60+
.br
61+
CALL MPI_ADDRESS(A(10,10), I2, IERROR)
62+
.br
63+
DIFF = I2 - I1
64+
.br
65+
! The value of DIFF is 909*sizeofreal; the values of I1 and I2 are
66+
.br
67+
! implementation dependent.
68+
.fi
69+
70+
.SH NOTES
71+
.ft R
72+
This routine is provided for both Fortran and C programmers and may be useful when writing portable code. In the current release, the address returned by this routine will be the same as that produced by the C & operator.
73+
.sp
74+
C users may be tempted to avoid using
75+
MPI_Address and rely on the availability of the address operator &.
76+
Note, however, that & cast-expression is a pointer, not an address.
77+
ANSI C does not require that the value of a pointer (or the pointer
78+
cast to int) be the absolute address of the object pointed at although
79+
this is commonly the case. Furthermore, referencing may not have a unique
80+
definition on machines with a segmented address space. The use of
81+
MPI_Address to "reference" C variables guarantees portability to
82+
such machines as well.
83+
84+
.SH ERRORS
85+
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.
86+
.sp
87+
Before the error value is returned, the current MPI error handler is
88+
called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler
89+
may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.
90+
91+
.SH SEE ALSO
92+
MPI_Get_address
93+
.br

‎ompi/mpi/man/man3/MPI_Errhandler_create.3in

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
3+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
4+
.\" Copyright (c) 1996 Thinking Machines Corporation
5+
.\" $COPYRIGHT$
6+
.TH MPI_Errhandler_create 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
7+
.SH NAME
8+
\fBMPI_Errhandler_create \fP \- Creates an MPI-style error handler -- use of this routine is deprecated.
9+
10+
.SH SYNTAX
11+
.ft R
12+
.SH C Syntax
13+
.nf
14+
#include <mpi.h>
15+
int MPI_Errhandler_create(MPI_Handler_function *\fIfunction\fP,
16+
MPI_Errhandler *\fIerrhandler\fP)
17+
18+
.fi
19+
.SH Fortran Syntax
20+
.nf
21+
INCLUDE 'mpif.h'
22+
MPI_ERRHANDLER_CREATE(\fIFUNCTION, ERRHANDLER, IERROR\fP)
23+
EXTERNAL \fIFUNCTION\fP
24+
INTEGER \fIERRHANDLER, IERROR\fP
25+
26+
27+
.fi
28+
.SH INPUT PARAMETER
29+
.ft R
30+
.TP 1i
31+
function
32+
User-defined error handling procedure.
33+
34+
.SH OUTPUT PARAMETERS
35+
.ft R
36+
.TP 1i
37+
errhandler
38+
MPI error handler (handle).
39+
.ft R
40+
.TP 1i
41+
IERROR
42+
Fortran only: Error status (integer).
43+
44+
.SH DESCRIPTION
45+
.ft R
46+
Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_create_errhandler instead.
47+
.sp
48+
This deprecated routine is not available in C++.
49+
.sp
50+
Registers the user routine function for use as an MPI exception handler. Returns in errhandler a handle to the registered exception handler.
51+
.sp
52+
In the C language, the user routine should be a C function of type MPI_Handler_function, which is defined as
53+
.sp
54+
.nf
55+
typedef void (MPI_Handler_function)(MPI_Comm *, int *, \&...);
56+
.fi
57+
.sp
58+
The first argument is the communicator in use. The second is the error code
59+
to be returned by the MPI routine that raised the error. If the routine would have returned MPI_ERR_IN_STATUS, it is the error code returned in the status for the request that caused the error handler to be invoked. The remaining arguments are stdargs arguments whose number and meaning is implementation-dependent. An implementation should clearly document these arguments. Addresses are used so that the handler may be written in Fortran.
60+
61+
.SH NOTE
62+
.ft R
63+
The MPI-1 Standard states that an implementation may make the output value (errhandler) simply the address of the function. However, the action of MPI_Errhandler_ free makes this impossible, since it is required to set the value of the argument to MPI_ERRHANDLER_NULL. In addition, the actual error handler must remain until all communicators that use it are freed.
64+
65+
.SH ERRORS
66+
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.
67+
.sp
68+
Before the error value is returned, the current MPI error handler is
69+
called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.
70+
71+
.SH SEE ALSO
72+
.br
73+
MPI_Comm_create_errhandler
74+
.br
75+
MPI_Comm_get_errhandler
76+
.br
77+
MPI_Comm_set_errhandler
78+
79+
80+

‎ompi/mpi/man/man3/MPI_Errhandler_get.3in

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
3+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
4+
.\" Copyright (c) 1996 Thinking Machines Corporation
5+
.\" $COPYRIGHT$
6+
.TH MPI_Errhandler_get 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
7+
.SH NAME
8+
\fBMPI_Errhandler_get \fP \- Gets the error handler for a communicator -- use of this routine is deprecated.
9+
10+
.SH SYNTAX
11+
.ft R
12+
.SH C Syntax
13+
.nf
14+
#include <mpi.h>
15+
int MPI_Errhandler_get(MPI_Comm \fIcomm\fP, MPI_Errhandler\fI *errhandler\fP)
16+
17+
.fi
18+
.SH Fortran Syntax
19+
.nf
20+
INCLUDE 'mpif.h'
21+
MPI_ERRHANDLER_GET(\fICOMM, ERRHANDLER, IERROR\fP)
22+
INTEGER \fICOMM, ERRHANDLER, IERROR\fP
23+
24+
25+
.fi
26+
.SH INPUT PARAMETER
27+
.ft R
28+
.TP 1i
29+
comm
30+
Communicator to get the error handler from (handle).
31+
32+
.SH OUTPUT PARAMETERS
33+
.ft R
34+
.TP 1i
35+
errhandler
36+
MPI error handler currently associated with communicator (handle).
37+
.ft R
38+
.TP 1i
39+
IERROR
40+
Fortran only: Error status (integer).
41+
42+
.SH DESCRIPTION
43+
.ft R
44+
Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_get_errhandler instead.
45+
.sp
46+
This deprecated routine is not available in C++.
47+
.sp
48+
Returns in errhandler (a handle to) the error handler that is currently associated with communicator comm.
49+
.sp
50+
\fBExample:\fP A library function may register at its entry point the current error handler for a communicator, set its own private error handler for this communicator, and restore before exiting the previous error handler.
51+
52+
53+
.SH ERRORS
54+
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.
55+
.sp
56+
Before the error value is returned, the current MPI error handler is
57+
called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.
58+
59+
.SH SEE ALSO
60+
.ft R
61+
.sp
62+
MPI_Comm_create_errhandler
63+
.br
64+
MPI_Comm_get_errhandler
65+
.br
66+
MPI_Comm_set_errhandler
67+

‎ompi/mpi/man/man3/MPI_Errhandler_set.3in

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright 2006-2008 Sun Microsystems, Inc.
3+
.\" Copyright (c) 1996 Thinking Machines Corporation
4+
.\" $COPYRIGHT$
5+
.TH MPI_Errhandler_set 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
6+
.SH NAME
7+
\fBMPI_Errhandler_set \fP \- Sets the error handler for a communicator -- use of this routine is deprecated.
8+
9+
.SH SYNTAX
10+
.ft R
11+
.SH C Syntax
12+
.nf
13+
#include <mpi.h>
14+
int MPI_Errhandler_set(MPI_Comm \fIcomm\fP, MPI_Errhandler \fIerrhandler\fP)
15+
16+
.fi
17+
.SH Fortran Syntax
18+
.nf
19+
INCLUDE 'mpif.h'
20+
MPI_ERRHANDLER_SET(\fICOMM, ERRHANDLER, IERROR\fP)
21+
INTEGER \fICOMM, ERRHANDLER, IERROR\fP
22+
23+
24+
.fi
25+
.SH INPUT PARAMETERS
26+
.ft R
27+
.TP 1i
28+
comm
29+
Communicator to set the error handler for (handle).
30+
.TP 1i
31+
errhandler
32+
New MPI error handler for communicator (handle).
33+
34+
.SH OUTPUT PARAMETER
35+
.ft R
36+
.TP 1i
37+
IERROR
38+
Fortran only: Error status (integer).
39+
40+
.SH DESCRIPTION
41+
.ft R
42+
Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_set_errhandler instead.
43+
.sp
44+
This deprecated routine is not available in C++.
45+
.sp
46+
Associates the new error handler errhandler with communicator comm at the calling process. Note that an error handler is always associated with the communicator.
47+
48+
.SH ERRORS
49+
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.
50+
.sp
51+
Before the error value is returned, the current MPI error handler is
52+
called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.
53+
54+
.SH SEE ALSO
55+
.ft R
56+
.sp
57+
MPI_Comm_create_errhandler
58+
.br
59+
MPI_Comm_get_errhandler
60+
.br
61+
MPI_Comm_set_errhandler
62+
63+

0 commit comments

Comments
 (0)