From e701bf35ccb24de427f09a1c88c29e891e13e92a Mon Sep 17 00:00:00 2001 From: Gilles Gouaillardet Date: Tue, 2 Jun 2015 19:09:01 +0900 Subject: [PATCH] MPI_Win_{get,set}_info : add man pages --- ompi/mpi/man/man3/MPI_Win_get_info.3in | 65 +++++++++++++++++++++++++ ompi/mpi/man/man3/MPI_Win_set_info.3in | 67 ++++++++++++++++++++++++++ ompi/mpi/man/man3/Makefile.extra | 2 + 3 files changed, 134 insertions(+) create mode 100644 ompi/mpi/man/man3/MPI_Win_get_info.3in create mode 100644 ompi/mpi/man/man3/MPI_Win_set_info.3in diff --git a/ompi/mpi/man/man3/MPI_Win_get_info.3in b/ompi/mpi/man/man3/MPI_Win_get_info.3in new file mode 100644 index 0000000000..dd3f0c17cc --- /dev/null +++ b/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 +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 diff --git a/ompi/mpi/man/man3/MPI_Win_set_info.3in b/ompi/mpi/man/man3/MPI_Win_set_info.3in new file mode 100644 index 0000000000..67b0e1d16e --- /dev/null +++ b/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 +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 diff --git a/ompi/mpi/man/man3/Makefile.extra b/ompi/mpi/man/man3/Makefile.extra index 014d2652a8..c15e674777 100644 --- a/ompi/mpi/man/man3/Makefile.extra +++ b/ompi/mpi/man/man3/Makefile.extra @@ -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 \