From f14a6c5089ad299c2f5eb43f90267456a2c9ce79 Mon Sep 17 00:00:00 2001 From: Colton Kammes Date: Sun, 25 Oct 2020 14:04:53 -0400 Subject: [PATCH] Converted MPI_Barrier.3in to MPI_Barrier.md Signed-off-by: Colton Kammes --- ompi/mpi/man/man3/MPI_Barrier.3in | 77 ------------------------------- ompi/mpi/man/man3/MPI_Barrier.md | 46 ++++++++++++++++++ ompi/mpi/man/man3/Makefile.am | 2 +- 3 files changed, 47 insertions(+), 78 deletions(-) delete mode 100644 ompi/mpi/man/man3/MPI_Barrier.3in create mode 100644 ompi/mpi/man/man3/MPI_Barrier.md diff --git a/ompi/mpi/man/man3/MPI_Barrier.3in b/ompi/mpi/man/man3/MPI_Barrier.3in deleted file mode 100644 index b6fa0745fd..0000000000 --- a/ompi/mpi/man/man3/MPI_Barrier.3in +++ /dev/null @@ -1,77 +0,0 @@ -.\" -*- nroff -*- -.\" Copyright (c) 2014-2015 Cisco Systems, Inc. All rights reserved. -.\" Copyright 2006-2008 Sun Microsystems, Inc. -.\" Copyright (c) 1996 Thinking Machines Corporation -.\" Copyright (c) 2020 Google, LLC. All rights reserved. -.\" $COPYRIGHT$ -.TH MPI_Barrier 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#" -.SH NAME -\fBMPI_Barrier, MPI_Ibarrier\fP \- Synchronization between MPI processes in a group - -.SH SYNTAX -.ft R -.SH C Syntax -.nf -#include -int MPI_Barrier(MPI_Comm \fIcomm\fP) - -int MPI_Ibarrier(MPI_Comm \fIcomm\fP, MPI_Request \fI*request\fP) - -.fi -.SH Fortran Syntax -.nf -USE MPI -! or the older form: INCLUDE 'mpif.h' -MPI_BARRIER(\fICOMM\fP,\fI IERROR\fP) - INTEGER \fICOMM\fP,\fI IERROR\fP - -MPI_IBARRIER(\fICOMM\fP, \fIREQUEST\fP, \fIIERROR\fP) - INTEGER \fICOMM\fP, \fIREQUEST\fP, \fIIERROR\fP - -.fi -.SH Fortran 2008 Syntax -.nf -USE mpi_f08 -MPI_Barrier(\fIcomm\fP, \fIierror\fP) - TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP - INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP - -MPI_Ibarrier(\fIcomm\fP, \fIrequest\fP, \fIierror\fP) - TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP - TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP - INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP - -.fi -.SH INPUT PARAMETER -.ft R -.TP 1i -comm -Communicator (handle). - -.SH OUTPUT PARAMETERS -.ft R -.TP 1i -request -Request (handle, non-blocking only). -.TP 1i -IERROR -Fortran only: Error status (integer). - -.SH DESCRIPTION -.ft R -An MPI barrier completes after all group members have entered the -barrier. - -.SH WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR -.sp -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. - -.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 -.ft R -MPI_Bcast diff --git a/ompi/mpi/man/man3/MPI_Barrier.md b/ompi/mpi/man/man3/MPI_Barrier.md new file mode 100644 index 0000000000..63ebbbccc4 --- /dev/null +++ b/ompi/mpi/man/man3/MPI_Barrier.md @@ -0,0 +1,46 @@ +# NAME + +MPI_Barrier, MPI_Ibarrier - Synchronization between MPI processes in a group + +# Syntax + +## C Syntax +```c +#include +int MPI_Barrier(MPI_Comm) +int MPI_Ibarrier(MPI_Comm comm, MPI_Request *request) +``` +## Fortran Syntax +```fortran +USE MPI +! or the older form: INCLUDE 'mpif.h' +MPI_BARRIER(COMM, IERROR) + INTEGER COMM, IERROR +MPI_IBARRIER(COMM, REQUEST, IERROR) + INTEGER COMM, REQUEST, IERROR +``` +## Fortran 2008 Syntax +```fortran +USE mpi_f08 +MPI_Barrier(comm, ierror) + TYPE(MPI_Comm), INTENT(IN) :: comm + INTEGER, OPTIONAL, INTENT(OUT) :: ierror +MPI_Ibarrier(comm, request, ierror) + TYPE(MPI_Comm), INTENT(IN) :: comm + TYPE(MPI_Request), INTENT (OUT) :: request + INTEGER, OPTIONAL, INTENT(OUT) :: ierror +``` +# Input Parameter +* `comm` : Communicator (handle). +# Output Parameters +* `request` : Request (handle, non-blocking only). +* `IERROR` : Fortran only: Error status (integer). +# Description +An MPI barrier completes after all groups members have entered the barrier. +# When Communicator is an Inter-Communicator +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. +# Errors +Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. +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. +# See Also +[`MPI_Bcast`(3)](MPI_Bcast.html) diff --git a/ompi/mpi/man/man3/Makefile.am b/ompi/mpi/man/man3/Makefile.am index f44459f4fb..7ac4c33176 100644 --- a/ompi/mpi/man/man3/Makefile.am +++ b/ompi/mpi/man/man3/Makefile.am @@ -24,6 +24,7 @@ include $(top_srcdir)/Makefile.ompi-rules # https://rmarkdown.rstudio.com/authoring_pandoc_markdown.html MD_FILES = \ + MPI_Barrier.md \ MPI_T_init_thread.3.md \ MPI_Status_f2c.3.md \ MPI_Status_f082c.3.md \ @@ -54,7 +55,6 @@ TEMPLATE_FILES = \ MPI_Attr_delete.3in \ MPI_Attr_get.3in \ MPI_Attr_put.3in \ - MPI_Barrier.3in \ MPI_Ibarrier.3in \ MPI_Bcast.3in \ MPI_Ibcast.3in \