MPI_Win_{get,set}_info : add man pages
Этот коммит содержится в:
родитель
6e2951e8d7
Коммит
e701bf35cc
65
ompi/mpi/man/man3/MPI_Win_get_info.3in
Обычный файл
65
ompi/mpi/man/man3/MPI_Win_get_info.3in
Обычный файл
@ -0,0 +1,65 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright (c) 2015 Research Organization for Information Science
|
||||
.\" and Technology (RIST). All rights reserved.
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Win_get_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.SH NAME
|
||||
\fBMPI_Win_get_info\fP \- Retrieves active window info hints
|
||||
.
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.SH C Syntax
|
||||
.nf
|
||||
#include <mpi.h>
|
||||
int MPI_Win_get_info(MPI_Win \fIwin\fP, MPI_Info \fI*info_used\fP)
|
||||
.
|
||||
.fi
|
||||
.SH Fortran Syntax
|
||||
.nf
|
||||
INCLUDE 'mpif.h'
|
||||
MPI_WIN_GET_INFO(\fIWIN, INFO_USED, IERROR\fP)
|
||||
INTEGER \fICOMM, INFO_USED, IERROR \fP
|
||||
.
|
||||
.fi
|
||||
.SH INPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
win
|
||||
Window from which to receive active info hints
|
||||
.
|
||||
.SH OUTPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
info_used
|
||||
New info object returned with all active hints on this window.
|
||||
.TP 1i
|
||||
IERROR
|
||||
Fortran only: Error status (integer).
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
MPI_Win_get_info returns a new info object containing the hints of
|
||||
the window associated with
|
||||
.IR win .
|
||||
The current setting of all hints actually used by the system related
|
||||
to this window is returned in
|
||||
.IR info_used .
|
||||
If no such hints exist, a handle to a newly created info object is
|
||||
returned that contains no key/value pair. The user is responsible for
|
||||
freeing info_used via MPI_Info_free.
|
||||
.
|
||||
.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.
|
||||
.sp
|
||||
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
|
||||
MPI_Win_set_info,
|
||||
MPI_Win_free
|
67
ompi/mpi/man/man3/MPI_Win_set_info.3in
Обычный файл
67
ompi/mpi/man/man3/MPI_Win_set_info.3in
Обычный файл
@ -0,0 +1,67 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright (c) 2015 Research Organization for Information Science
|
||||
.\" and Technology (RIST). All rights reserved.
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Win_set_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
||||
.SH NAME
|
||||
\fBMPI_Win_set_info\fP \- Set window info hints
|
||||
.
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.SH C Syntax
|
||||
.nf
|
||||
#include <mpi.h>
|
||||
int MPI_Win_set_info(MPI_Win \fIwin\fP, MPI_Info \fIinfo\fP)
|
||||
.
|
||||
.fi
|
||||
.SH Fortran Syntax
|
||||
.nf
|
||||
INCLUDE 'mpif.h'
|
||||
MPI_WIN_SET_INFO(\fIWIN, INFO, IERROR\fP)
|
||||
INTEGER \fIWIN, INFO, IERROR \fP
|
||||
.
|
||||
.fi
|
||||
.SH INPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
win
|
||||
Window on which to set info hints
|
||||
.TP 1i
|
||||
info
|
||||
Info object containing hints to be set on
|
||||
.I win
|
||||
.
|
||||
.SH OUTPUT PARAMETERS
|
||||
.TP 1i
|
||||
IERROR
|
||||
Fortran only: Error status (integer).
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
MPI_WIN_SET_INFO sets new values for the hints of the window
|
||||
associated with
|
||||
.IR win.
|
||||
MPI_WIN_SET_INFO is a collective routine. The info object may be
|
||||
different on each process, but any info entries that an implementation
|
||||
requires to be the same on all processes must appear with the same
|
||||
value in each process's
|
||||
.I info
|
||||
object.
|
||||
.
|
||||
.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.
|
||||
.sp
|
||||
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
|
||||
MPI_Win_get_info,
|
||||
MPI_Info_create,
|
||||
MPI_Info_set,
|
||||
MPI_Info_free
|
@ -400,12 +400,14 @@ mpi_api_man_pages = \
|
||||
mpi/man/man3/MPI_Win_get_attr.3 \
|
||||
mpi/man/man3/MPI_Win_get_errhandler.3 \
|
||||
mpi/man/man3/MPI_Win_get_group.3 \
|
||||
mpi/man/man3/MPI_Win_get_info.3 \
|
||||
mpi/man/man3/MPI_Win_get_name.3 \
|
||||
mpi/man/man3/MPI_Win_lock.3 \
|
||||
mpi/man/man3/MPI_Win_lock_all.3 \
|
||||
mpi/man/man3/MPI_Win_post.3 \
|
||||
mpi/man/man3/MPI_Win_set_attr.3 \
|
||||
mpi/man/man3/MPI_Win_set_errhandler.3 \
|
||||
mpi/man/man3/MPI_Win_set_info.3 \
|
||||
mpi/man/man3/MPI_Win_set_name.3 \
|
||||
mpi/man/man3/MPI_Win_start.3 \
|
||||
mpi/man/man3/MPI_Win_sync.3 \
|
||||
|
Загрузка…
Ссылка в новой задаче
Block a user