Skip to content

Commit 105636c

Browse files
authored
Merge pull request #8134 from Colton-K/pr/MPI_Barrier-to-md
Converted MPI_Barrier.3in to MPI_Barrier.md
2 parents d52bf35 + f14a6c5 commit 105636c

File tree

3 files changed

+47
-78
lines changed

3 files changed

+47
-78
lines changed

ompi/mpi/man/man3/MPI_Barrier.3in

Lines changed: 0 additions & 77 deletions
This file was deleted.

ompi/mpi/man/man3/MPI_Barrier.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# NAME
2+
3+
MPI_Barrier, MPI_Ibarrier - Synchronization between MPI processes in a group
4+
5+
# Syntax
6+
7+
## C Syntax
8+
```c
9+
#include <mpi.h>
10+
int MPI_Barrier(MPI_Comm)
11+
int MPI_Ibarrier(MPI_Comm comm, MPI_Request *request)
12+
```
13+
## Fortran Syntax
14+
```fortran
15+
USE MPI
16+
! or the older form: INCLUDE 'mpif.h'
17+
MPI_BARRIER(COMM, IERROR)
18+
INTEGER COMM, IERROR
19+
MPI_IBARRIER(COMM, REQUEST, IERROR)
20+
INTEGER COMM, REQUEST, IERROR
21+
```
22+
## Fortran 2008 Syntax
23+
```fortran
24+
USE mpi_f08
25+
MPI_Barrier(comm, ierror)
26+
TYPE(MPI_Comm), INTENT(IN) :: comm
27+
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
28+
MPI_Ibarrier(comm, request, ierror)
29+
TYPE(MPI_Comm), INTENT(IN) :: comm
30+
TYPE(MPI_Request), INTENT (OUT) :: request
31+
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
32+
```
33+
# Input Parameter
34+
* `comm` : Communicator (handle).
35+
# Output Parameters
36+
* `request` : Request (handle, non-blocking only).
37+
* `IERROR` : Fortran only: Error status (integer).
38+
# Description
39+
An MPI barrier completes after all groups members have entered the barrier.
40+
# When Communicator is an Inter-Communicator
41+
When the communicator is an inter-communicator, the barrier operation is performed across all processes in both groups. All processes in the first group may exit the barrier when all processes in the second group have entered the barrier.
42+
# Errors
43+
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
44+
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.
45+
# See Also
46+
[`MPI_Bcast`(3)](MPI_Bcast.html)

ompi/mpi/man/man3/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ include $(top_srcdir)/Makefile.ompi-rules
2424
# https://rmarkdown.rstudio.com/authoring_pandoc_markdown.html
2525

2626
MD_FILES = \
27+
MPI_Barrier.md \
2728
MPI_T_init_thread.3.md \
2829
MPI_Status_f2c.3.md \
2930
MPI_Status_f082c.3.md \
@@ -54,7 +55,6 @@ TEMPLATE_FILES = \
5455
MPI_Attr_delete.3in \
5556
MPI_Attr_get.3in \
5657
MPI_Attr_put.3in \
57-
MPI_Barrier.3in \
5858
MPI_Ibarrier.3in \
5959
MPI_Bcast.3in \
6060
MPI_Ibcast.3in \

0 commit comments

Comments
 (0)