Merge pull request #7484 from yanagibashi/pr/fix-typos-and-descriptions

man: fix typos and descriptions.
2020-02-27 06:24:50 -05:00 · 2020-02-27 06:24:50 -05:00 · 19acb32a3f
--- a/ompi/mpi/man/man3/MPI_Comm_accept.3in
+++ b/ompi/mpi/man/man3/MPI_Comm_accept.3in
@ -4,8 +4,9 @@
 .\" Copyright 2007, Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
-.TH MPI_Comm_accept 3OpenMPI "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
+.TH MPI_Comm_accept 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
 \fBMPI_Comm_accept \fP \- Establishes communication with a client.

--- a/ompi/mpi/man/man3/MPI_Dist_graph_create.3in
+++ b/ompi/mpi/man/man3/MPI_Dist_graph_create.3in
@ -3,6 +3,7 @@
 .\" Copyright 2010 Cisco Systems, Inc.  All rights reserved.
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Dist_graph_create 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -53,7 +54,7 @@ n
 Number of source nodes for which this process specifies edges (non-negative integer).
 .TP 1i
 sources
-Array containing the \fIn\fP source nodes for which this process species edges (array of non-negative integers).
+Array containing the \fIn\fP source nodes for which this process specifies edges (array of non-negative integers).
 .TP 1i
 degrees
 Array specifying the number of destinations for each source node in the source node array (array of non-negative integers).
@ -64,6 +65,7 @@ Destination nodes for the source nodes in the source node array (array of non-ne
 weights
 Weights for source to destination edges (array of non-negative integers).
 .TP 1i
+info
 Hints on optimization and interpretation of weights (handle).
 .TP 1i
 reorder
@ -73,7 +75,7 @@ Ranking may be reordered (true) or not (false) (logical).
 .ft R
 .TP 1i
 comm_dist_graph
-Communicator with distibuted graph topology added (handle).
+Communicator with distributed graph topology added (handle).
 .ft R
 .TP 1i
 IERROR
@ -88,7 +90,7 @@ constructor with a set of directed (source,destination) communication edges as d
 Every process passes an array of \fIn\fP source nodes in the \fIsources\fP array. For each source node, a
 non-negative number of destination nodes is specied in the \fIdegrees\fP array. The destination
 nodes are stored in the corresponding consecutive segment of the \fIdestinations\fP array. More
-precisely, if the i-th node in sources is s, this species \fIdegrees\fP[i] \fIedges\fP (s,d) with d of the j-th
+precisely, if the i-th node in sources is s, this specifies \fIdegrees\fP[i] \fIedges\fP (s,d) with d of the j-th
 such edge stored in \fIdestinations\fP[\fIdegrees\fP[0]+...+\fIdegrees\fP[i-1]+j]. The weight of this edge is
 stored in \fIweights\fP[\fIdegrees\fP[0]+...+\fIdegrees\fP[i-1]+j]. Both the \fIsources\fP and the \fIdestinations\fP arrays
 may contain the same node more than once, and the order in which nodes are listed as
--- a/ompi/mpi/man/man3/MPI_Dist_graph_create_adjacent.3in
+++ b/ompi/mpi/man/man3/MPI_Dist_graph_create_adjacent.3in
@ -3,6 +3,7 @@
 .\" Copyright 2010 Cisco Systems, Inc.  All rights reserved.
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Dist_graph_create_adjacent 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -68,6 +69,7 @@ Ranks of processes for which the calling process is a source (array of non-negat
 destweights
 Weights of the edges out of the calling process (array of non-negative integers).
 .TP 1i
+info
 Hints on optimization and interpretation of weights (handle).
 .TP 1i
 reorder
@ -77,7 +79,7 @@ Ranking may be reordered (true) or not (false) (logical).
 .ft R
 .TP 1i
 comm_dist_graph
-Communicator with distibuted graph topology added (handle).
+Communicator with distributed graph topology added (handle).
 .ft R
 .TP 1i
 IERROR
--- a/ompi/mpi/man/man3/MPI_File_get_position_shared.3in
+++ b/ompi/mpi/man/man3/MPI_File_get_position_shared.3in
@ -5,6 +5,7 @@
 .\" Copyright 2015      Research Organization for Information Science
 .\"                     and Technology (RIST). All rights reserved.
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_File_get_position_shared 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -14,8 +15,9 @@
 .ft R
 .nf
 .SH C Syntax
-    #include <mpi.h>
-    int MPI_File_get_position_shared(MPI_File \fIfh\fP, MPI_Offset \fI*offset\fP)
+.nf
+#include <mpi.h>
+int MPI_File_get_position_shared(MPI_File \fIfh\fP, MPI_Offset \fI*offset\fP)

 .fi
 .SH Fortran Syntax (see FORTRAN 77 NOTES)
--- a/ompi/mpi/man/man3/MPI_Request_free.3in
+++ b/ompi/mpi/man/man3/MPI_Request_free.3in
@ -3,6 +3,7 @@
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Request_free 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -18,7 +19,8 @@ int MPI_Request_free(MPI_Request *request)
 .fi
 .SH Fortran Syntax
 .nf
-\s-1INCLUDE\s0 'mpif.h'
+USE MPI
+! or the older form: INCLUDE 'mpif.h'
 MPI_REQUEST_FREE(REQUEST, IERROR)
 	INTEGER	REQUEST, IERROR

--- a/ompi/mpi/man/man3/MPI_Scan.3in
+++ b/ompi/mpi/man/man3/MPI_Scan.3in
@ -4,6 +4,7 @@
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Scan 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"

@ -38,6 +39,7 @@ MPI_ISCAN(\fISENDBUF, RECVBUF, COUNT, DATATYPE, OP, COMM, REQUEST, IERROR\fP)

 .fi
 .SH Fortran 2008 Syntax
+.nf
 USE mpi_f08
 MPI_Scan(\fIsendbuf\fP, \fIrecvbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIop\fP, \fIcomm\fP, \fIierror\fP)
 	TYPE(*), DIMENSION(..), INTENT(IN) :: \fIsendbuf\fP
--- a/ompi/mpi/man/man3/MPI_Scatterv.3in
+++ b/ompi/mpi/man/man3/MPI_Scatterv.3in
@ -4,6 +4,7 @@
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines Corporation
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Scatterv 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -41,6 +42,7 @@ MPI_ISCATTERV(\fISENDBUF, SENDCOUNTS, DISPLS, SENDTYPE, RECVBUF,

 .fi
 .SH Fortran 2008 Syntax
+.nf
 USE mpi_f08
 MPI_Scatterv(\fIsendbuf\fP, \fIsendcounts\fP, \fIdispls\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcount\fP,
 		\fIrecvtype\fP, \fIroot\fP, \fIcomm\fP, \fIierror\fP)
--- a/ompi/mpi/man/man3/MPI_Type_create_indexed_block.3in
+++ b/ompi/mpi/man/man3/MPI_Type_create_indexed_block.3in
@ -4,6 +4,7 @@
 .\" Copyright 2006-2008 Sun Microsystems, Inc.
 .\" Copyright (c) 1996 Thinking Machines
 .\" Copyright (c) 2020      Google, LLC. All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Type_create_indexed_block 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -36,6 +37,7 @@ MPI_TYPE_CREATE_HINDEXED_BLOCK(\fICOUNT, BLOCKLENGTH,

 .fi
 .SH Fortran 2008 Syntax
+.nf
 USE mpi_f08
 MPI_Type_create_indexed_block(\fIcount\fP, \fIblocklength\fP, \fIarray_of_displacements\fP,
 		\fIoldtype\fP, \fInewtype\fP, \fIierror\fP)
--- a/ompi/mpi/man/man3/MPI_Win_attach.3in
+++ b/ompi/mpi/man/man3/MPI_Win_attach.3in
@ -1,7 +1,7 @@
 .\" -*- nroff -*-
 .\" Copyright (c) 2015-2019 Research Organization for Information Science
 .\"                         and Technology (RIST).  All rights reserved.
-.\" Copyright (c) 2019      FUJITSU LIMITED.  All rights reserved.
+.\" Copyright (c) 2019-2020 FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Win_attach 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -25,6 +25,9 @@ MPI_WIN_ATTACH(\fIWIN, BASE, SIZE, IERROR\fP)
 	INTEGER(KIND=MPI_ADDRESS_KIND) \fISIZE\fP
 	INTEGER \fIWIN, IERROR\fP

+MPI_WIN_DETACH(\fIWIN, BASE, IERROR\fP)
+	<type> \fIBASE\fP(*)
+	INTEGER \fIWIN, IERROR\fP
 .fi
 .SH Fortran 2008 Syntax
 .nf
@ -35,6 +38,10 @@ MPI_Win_attach(\fIwin\fP, \fIbase\fP, \fIsize\fP, \fIierror\fP)
 	INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: \fIsize\fP
 	INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP

+MPI_Win_detach(\fIwin\fP, \fIbase\fP, \fIierror\fP)
+	TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
+	TYPE(*), DIMENSION(..), INTENT(IN) :: \fIbase\fP
+	INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
 .fi
 .SH INPUT PARAMETERS
 .ft R
--- a/ompi/mpi/man/man3/MPI_Win_get_info.3in
+++ b/ompi/mpi/man/man3/MPI_Win_get_info.3in
@ -1,6 +1,7 @@
 .\" -*- nroff -*-
 .\" Copyright (c) 2015      Research Organization for Information Science
 .\"                         and Technology (RIST). All rights reserved.
+.\" Copyright (c) 2020      FUJITSU LIMITED.  All rights reserved.
 .\" $COPYRIGHT$
 .TH MPI_Win_get_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
 .SH NAME
@ -19,7 +20,7 @@ int MPI_Win_get_info(MPI_Win \fIwin\fP, MPI_Info \fI*info_used\fP)
 USE MPI
 ! or the older form: INCLUDE 'mpif.h'
 MPI_WIN_GET_INFO(\fIWIN, INFO_USED, IERROR\fP)
-	INTEGER	\fICOMM, INFO_USED, IERROR \fP
+	INTEGER	\fIWIN, INFO_USED, IERROR \fP
 .
 .fi
 .SH Fortran 2008 Syntax