man: update man pages for Init*/Finalize*
Update language surrounding initialization and finalization in MPI_Init[_thread], MPI_Initialized, MPI_Finalize, and MPI_Finalized.
Этот коммит содержится в:
Jeff Squyres
родитель
f5ad90c920
Коммит
338257a2f4
@ -1,5 +1,5 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
@ -63,3 +63,10 @@ Before the error value is returned, the current MPI error handler is
|
||||
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.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.ft R
|
||||
.nf
|
||||
MPI_Init
|
||||
MPI_Init_thread
|
||||
MPI_Initialized
|
||||
MPI_Finalized
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Finalized 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.SH NAME
|
||||
\fBMPI_Finalized \fP \- Checks whether MPI_Finalize has completed.
|
||||
\fBMPI_Finalized \fP \- Checks whether MPI has been finalized
|
||||
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
@ -42,7 +42,7 @@ bool MPI::Is_finalized()
|
||||
.ft R
|
||||
.TP 1i
|
||||
flag
|
||||
True if MPI was finalized (logical).
|
||||
True if MPI was finalized, and false otherwise (logical).
|
||||
.ft R
|
||||
.TP 1i
|
||||
IERROR
|
||||
@ -50,7 +50,10 @@ Fortran only: Error status (integer).
|
||||
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
This routine returns "true" if MPI_Finalize has completed. You can call MPI_Finalized before MPI_Init and after MPI_Finalize.
|
||||
This routine may be used to determine whether MPI has been finalized.
|
||||
It is one of a small number of routines that may be called before MPI
|
||||
is initialized and after MPI has been finalized (MPI_Initialized is
|
||||
another).
|
||||
|
||||
.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.
|
||||
@ -58,3 +61,10 @@ Almost all MPI routines return an error value; C routines as the value of the fu
|
||||
Before the error value is returned, the current MPI error handler is
|
||||
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.
|
||||
|
||||
.SH SEE ALSO
|
||||
.ft R
|
||||
.nf
|
||||
MPI_Init
|
||||
MPI_Init_thread
|
||||
MPI_Initialized
|
||||
MPI_Finalize
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
@ -56,10 +56,10 @@ Fortran only: Error status (integer).
|
||||
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
This routine, or MPI_Init_thread, must be called before any other MPI
|
||||
routine (apart from MPI_Initialized) is called. MPI can be initialized
|
||||
at most once; subsequent calls to MPI_Init or MPI_Init_thread are
|
||||
erroneous.
|
||||
This routine, or MPI_Init_thread, must be called before most other MPI
|
||||
routines are called. There are a small number of exceptions, such as
|
||||
MPI_Initialized and MPI_Finalized. MPI can be initialized at most
|
||||
once; subsequent calls to MPI_Init or MPI_Init_thread are erroneous.
|
||||
.sp
|
||||
All MPI programs must contain a call to MPI_Init or
|
||||
MPI_Init_thread. Open MPI accepts the C/C++ \fIargc\fP and \fIargv\fP
|
||||
@ -110,4 +110,4 @@ See the MPI man page for a full list of MPI error codes.
|
||||
MPI_Init_thread
|
||||
MPI_Initialized
|
||||
MPI_Finalize
|
||||
|
||||
MPI_Finalized
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Init_thread 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.
|
||||
@ -67,8 +67,9 @@ Fortran only: Error status (integer).
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
This routine, or MPI_Init, must be called before any other MPI routine
|
||||
(apart from MPI_Initialized) is called. MPI can be initialized at most
|
||||
This routine, or MPI_Init, must be called before most other MPI
|
||||
routines are called. There are a small number of exceptions, such as
|
||||
MPI_Initialized and MPI_Finalized. MPI can be initialized at most
|
||||
once; subsequent calls to MPI_Init or MPI_Init_thread are erroneous.
|
||||
.sp
|
||||
MPI_Init_thread, as compared to MPI_Init, has a provision to request a
|
||||
@ -203,4 +204,4 @@ guarantee that an MPI program can continue past an error.
|
||||
MPI_Init
|
||||
MPI_Initialized
|
||||
MPI_Finalize
|
||||
|
||||
MPI_Finalized
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Initialized 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.SH NAME
|
||||
\fBMPI_Initialized\fP \- Indicates whether MPI_Init has been called.
|
||||
\fBMPI_Initialized\fP \- Checks whether MPI has been initialized
|
||||
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
@ -42,7 +42,7 @@ bool Is_initialized()
|
||||
.ft R
|
||||
.TP 1i
|
||||
flag
|
||||
Flag is true if MPI_Init has been called and false otherwise.
|
||||
True if MPI has been initialized, and false otherwise (logical).
|
||||
.ft R
|
||||
.TP 1i
|
||||
IERROR
|
||||
@ -50,7 +50,10 @@ Fortran only: Error status (integer).
|
||||
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
This routine may be used to determine whether MPI_Init has been called. It is the only routine that may be called before MPI_Init is called.
|
||||
This routine may be used to determine whether MPI has been
|
||||
initialized. It is one of a small number of routines that may be
|
||||
called before MPI is initialized and after MPI has been finalized
|
||||
(MPI_Finalized is another).
|
||||
|
||||
.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.
|
||||
@ -60,6 +63,8 @@ called. By default, this error handler aborts the MPI job, except for I/O functi
|
||||
|
||||
.SH SEE ALSO
|
||||
.ft R
|
||||
.sp
|
||||
.nf
|
||||
MPI_Init
|
||||
|
||||
MPI_Init_thread
|
||||
MPI_Finalize
|
||||
MPI_Finalized
|
||||
|
||||
Загрузка…
x
Ссылка в новой задаче
Block a user