Skip to content

Commit e701bf3

Browse files
ggouaillardetggouaillardet
committed
MPI_Win_{get,set}_info : add man pages
1 parent 6e2951e commit e701bf3

File tree

3 files changed

+134
-0
lines changed

3 files changed

+134
-0
lines changed

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright (c) 2015 Research Organization for Information Science
3+
.\" and Technology (RIST). All rights reserved.
4+
.\" $COPYRIGHT$
5+
.TH MPI_Win_get_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
6+
.SH NAME
7+
\fBMPI_Win_get_info\fP \- Retrieves active window info hints
8+
.
9+
.SH SYNTAX
10+
.ft R
11+
.SH C Syntax
12+
.nf
13+
#include <mpi.h>
14+
int MPI_Win_get_info(MPI_Win \fIwin\fP, MPI_Info \fI*info_used\fP)
15+
.
16+
.fi
17+
.SH Fortran Syntax
18+
.nf
19+
INCLUDE 'mpif.h'
20+
MPI_WIN_GET_INFO(\fIWIN, INFO_USED, IERROR\fP)
21+
INTEGER \fICOMM, INFO_USED, IERROR \fP
22+
.
23+
.fi
24+
.SH INPUT PARAMETERS
25+
.ft R
26+
.TP 1i
27+
win
28+
Window from which to receive active info hints
29+
.
30+
.SH OUTPUT PARAMETERS
31+
.ft R
32+
.TP 1i
33+
info_used
34+
New info object returned with all active hints on this window.
35+
.TP 1i
36+
IERROR
37+
Fortran only: Error status (integer).
38+
.
39+
.SH DESCRIPTION
40+
.ft R
41+
MPI_Win_get_info returns a new info object containing the hints of
42+
the window associated with
43+
.IR win .
44+
The current setting of all hints actually used by the system related
45+
to this window is returned in
46+
.IR info_used .
47+
If no such hints exist, a handle to a newly created info object is
48+
returned that contains no key/value pair. The user is responsible for
49+
freeing info_used via MPI_Info_free.
50+
.
51+
.SH ERRORS
52+
Almost all MPI routines return an error value; C routines as the value
53+
of the function and Fortran routines in the last argument.
54+
.sp
55+
Before the error value is returned, the current MPI error handler is
56+
called. By default, this error handler aborts the MPI job, except for
57+
I/O function errors. The error handler may be changed with
58+
MPI_Comm_set_errhandler; the predefined error handler
59+
MPI_ERRORS_RETURN may be used to cause error values to be
60+
returned. Note that MPI does not guarantee that an MPI program can
61+
continue past an error.
62+
.
63+
.SH SEE ALSO
64+
MPI_Win_set_info,
65+
MPI_Win_free

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

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.\" -*- nroff -*-
2+
.\" Copyright (c) 2015 Research Organization for Information Science
3+
.\" and Technology (RIST). All rights reserved.
4+
.\" $COPYRIGHT$
5+
.TH MPI_Win_set_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
6+
.SH NAME
7+
\fBMPI_Win_set_info\fP \- Set window info hints
8+
.
9+
.SH SYNTAX
10+
.ft R
11+
.SH C Syntax
12+
.nf
13+
#include <mpi.h>
14+
int MPI_Win_set_info(MPI_Win \fIwin\fP, MPI_Info \fIinfo\fP)
15+
.
16+
.fi
17+
.SH Fortran Syntax
18+
.nf
19+
INCLUDE 'mpif.h'
20+
MPI_WIN_SET_INFO(\fIWIN, INFO, IERROR\fP)
21+
INTEGER \fIWIN, INFO, IERROR \fP
22+
.
23+
.fi
24+
.SH INPUT PARAMETERS
25+
.ft R
26+
.TP 1i
27+
win
28+
Window on which to set info hints
29+
.TP 1i
30+
info
31+
Info object containing hints to be set on
32+
.I win
33+
.
34+
.SH OUTPUT PARAMETERS
35+
.TP 1i
36+
IERROR
37+
Fortran only: Error status (integer).
38+
.
39+
.SH DESCRIPTION
40+
.ft R
41+
MPI_WIN_SET_INFO sets new values for the hints of the window
42+
associated with
43+
.IR win.
44+
MPI_WIN_SET_INFO is a collective routine. The info object may be
45+
different on each process, but any info entries that an implementation
46+
requires to be the same on all processes must appear with the same
47+
value in each process's
48+
.I info
49+
object.
50+
.
51+
.SH ERRORS
52+
Almost all MPI routines return an error value; C routines as the value
53+
of the function and Fortran routines in the last argument.
54+
.sp
55+
Before the error value is returned, the current MPI error handler is
56+
called. By default, this error handler aborts the MPI job, except for
57+
I/O function errors. The error handler may be changed with
58+
MPI_Comm_set_errhandler; the predefined error handler
59+
MPI_ERRORS_RETURN may be used to cause error values to be
60+
returned. Note that MPI does not guarantee that an MPI program can
61+
continue past an error.
62+
.
63+
.SH SEE ALSO
64+
MPI_Win_get_info,
65+
MPI_Info_create,
66+
MPI_Info_set,
67+
MPI_Info_free

‎ompi/mpi/man/man3/Makefile.extra‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,12 +400,14 @@ mpi_api_man_pages = \
400400
mpi/man/man3/MPI_Win_get_attr.3 \
401401
mpi/man/man3/MPI_Win_get_errhandler.3 \
402402
mpi/man/man3/MPI_Win_get_group.3 \
403+
mpi/man/man3/MPI_Win_get_info.3 \
403404
mpi/man/man3/MPI_Win_get_name.3 \
404405
mpi/man/man3/MPI_Win_lock.3 \
405406
mpi/man/man3/MPI_Win_lock_all.3 \
406407
mpi/man/man3/MPI_Win_post.3 \
407408
mpi/man/man3/MPI_Win_set_attr.3 \
408409
mpi/man/man3/MPI_Win_set_errhandler.3 \
410+
mpi/man/man3/MPI_Win_set_info.3 \
409411
mpi/man/man3/MPI_Win_set_name.3 \
410412
mpi/man/man3/MPI_Win_start.3 \
411413
mpi/man/man3/MPI_Win_sync.3 \

0 commit comments

Comments
 (0)