Skip to content

Commit 19acb32

Browse files
authored
Merge pull request #7484 from yanagibashi/pr/fix-typos-and-descriptions
man: fix typos and descriptions.
2 parents 85db549 + b604f1f commit 19acb32

10 files changed

+33
-10
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
.\" Copyright 2007, Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines Corporation
66
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
7+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
78
.\" $COPYRIGHT$
8-
.TH MPI_Comm_accept 3OpenMPI "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
9+
.TH MPI_Comm_accept 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
910
.SH NAME
1011
\fBMPI_Comm_accept \fP \- Establishes communication with a client.
1112

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
44
.\" Copyright 2006-2008 Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines Corporation
6+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
67
.\" $COPYRIGHT$
78
.TH MPI_Dist_graph_create 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
89
.SH NAME
@@ -53,7 +54,7 @@ n
5354
Number of source nodes for which this process specifies edges (non-negative integer).
5455
.TP 1i
5556
sources
56-
Array containing the \fIn\fP source nodes for which this process species edges (array of non-negative integers).
57+
Array containing the \fIn\fP source nodes for which this process specifies edges (array of non-negative integers).
5758
.TP 1i
5859
degrees
5960
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
6465
weights
6566
Weights for source to destination edges (array of non-negative integers).
6667
.TP 1i
68+
info
6769
Hints on optimization and interpretation of weights (handle).
6870
.TP 1i
6971
reorder
@@ -73,7 +75,7 @@ Ranking may be reordered (true) or not (false) (logical).
7375
.ft R
7476
.TP 1i
7577
comm_dist_graph
76-
Communicator with distibuted graph topology added (handle).
78+
Communicator with distributed graph topology added (handle).
7779
.ft R
7880
.TP 1i
7981
IERROR
@@ -88,7 +90,7 @@ constructor with a set of directed (source,destination) communication edges as d
8890
Every process passes an array of \fIn\fP source nodes in the \fIsources\fP array. For each source node, a
8991
non-negative number of destination nodes is specied in the \fIdegrees\fP array. The destination
9092
nodes are stored in the corresponding consecutive segment of the \fIdestinations\fP array. More
91-
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
93+
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
9294
such edge stored in \fIdestinations\fP[\fIdegrees\fP[0]+...+\fIdegrees\fP[i-1]+j]. The weight of this edge is
9395
stored in \fIweights\fP[\fIdegrees\fP[0]+...+\fIdegrees\fP[i-1]+j]. Both the \fIsources\fP and the \fIdestinations\fP arrays
9496
may contain the same node more than once, and the order in which nodes are listed as

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
44
.\" Copyright 2006-2008 Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines Corporation
6+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
67
.\" $COPYRIGHT$
78
.TH MPI_Dist_graph_create_adjacent 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
89
.SH NAME
@@ -68,6 +69,7 @@ Ranks of processes for which the calling process is a source (array of non-negat
6869
destweights
6970
Weights of the edges out of the calling process (array of non-negative integers).
7071
.TP 1i
72+
info
7173
Hints on optimization and interpretation of weights (handle).
7274
.TP 1i
7375
reorder
@@ -77,7 +79,7 @@ Ranking may be reordered (true) or not (false) (logical).
7779
.ft R
7880
.TP 1i
7981
comm_dist_graph
80-
Communicator with distibuted graph topology added (handle).
82+
Communicator with distributed graph topology added (handle).
8183
.ft R
8284
.TP 1i
8385
IERROR

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
.\" Copyright 2015 Research Organization for Information Science
66
.\" and Technology (RIST). All rights reserved.
77
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
8+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
89
.\" $COPYRIGHT$
910
.TH MPI_File_get_position_shared 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
1011
.SH NAME
@@ -14,8 +15,9 @@
1415
.ft R
1516
.nf
1617
.SH C Syntax
17-
#include <mpi.h>
18-
int MPI_File_get_position_shared(MPI_File \fIfh\fP, MPI_Offset \fI*offset\fP)
18+
.nf
19+
#include <mpi.h>
20+
int MPI_File_get_position_shared(MPI_File \fIfh\fP, MPI_Offset \fI*offset\fP)
1921

2022
.fi
2123
.SH Fortran Syntax (see FORTRAN 77 NOTES)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.\" Copyright 2006-2008 Sun Microsystems, Inc.
44
.\" Copyright (c) 1996 Thinking Machines Corporation
55
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
6+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
67
.\" $COPYRIGHT$
78
.TH MPI_Request_free 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
89
.SH NAME
@@ -18,7 +19,8 @@ int MPI_Request_free(MPI_Request *request)
1819
.fi
1920
.SH Fortran Syntax
2021
.nf
21-
\s-1INCLUDE\s0 'mpif.h'
22+
USE MPI
23+
! or the older form: INCLUDE 'mpif.h'
2224
MPI_REQUEST_FREE(REQUEST, IERROR)
2325
INTEGER REQUEST, IERROR
2426

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.\" Copyright 2006-2008 Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines Corporation
66
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
7+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
78
.\" $COPYRIGHT$
89
.TH MPI_Scan 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
910

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

3940
.fi
4041
.SH Fortran 2008 Syntax
42+
.nf
4143
USE mpi_f08
4244
MPI_Scan(\fIsendbuf\fP, \fIrecvbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIop\fP, \fIcomm\fP, \fIierror\fP)
4345
TYPE(*), DIMENSION(..), INTENT(IN) :: \fIsendbuf\fP

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.\" Copyright 2006-2008 Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines Corporation
66
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
7+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
78
.\" $COPYRIGHT$
89
.TH MPI_Scatterv 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
910
.SH NAME
@@ -41,6 +42,7 @@ MPI_ISCATTERV(\fISENDBUF, SENDCOUNTS, DISPLS, SENDTYPE, RECVBUF,
4142

4243
.fi
4344
.SH Fortran 2008 Syntax
45+
.nf
4446
USE mpi_f08
4547
MPI_Scatterv(\fIsendbuf\fP, \fIsendcounts\fP, \fIdispls\fP, \fIsendtype\fP, \fIrecvbuf\fP, \fIrecvcount\fP,
4648
\fIrecvtype\fP, \fIroot\fP, \fIcomm\fP, \fIierror\fP)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.\" Copyright 2006-2008 Sun Microsystems, Inc.
55
.\" Copyright (c) 1996 Thinking Machines
66
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
7+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
78
.\" $COPYRIGHT$
89
.TH MPI_Type_create_indexed_block 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
910
.SH NAME
@@ -36,6 +37,7 @@ MPI_TYPE_CREATE_HINDEXED_BLOCK(\fICOUNT, BLOCKLENGTH,
3637

3738
.fi
3839
.SH Fortran 2008 Syntax
40+
.nf
3941
USE mpi_f08
4042
MPI_Type_create_indexed_block(\fIcount\fP, \fIblocklength\fP, \fIarray_of_displacements\fP,
4143
\fIoldtype\fP, \fInewtype\fP, \fIierror\fP)

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" -*- nroff -*-
22
.\" Copyright (c) 2015-2019 Research Organization for Information Science
33
.\" and Technology (RIST). All rights reserved.
4-
.\" Copyright (c) 2019 FUJITSU LIMITED. All rights reserved.
4+
.\" Copyright (c) 2019-2020 FUJITSU LIMITED. All rights reserved.
55
.\" $COPYRIGHT$
66
.TH MPI_Win_attach 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
77
.SH NAME
@@ -25,6 +25,9 @@ MPI_WIN_ATTACH(\fIWIN, BASE, SIZE, IERROR\fP)
2525
INTEGER(KIND=MPI_ADDRESS_KIND) \fISIZE\fP
2626
INTEGER \fIWIN, IERROR\fP
2727

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

41+
MPI_Win_detach(\fIwin\fP, \fIbase\fP, \fIierror\fP)
42+
TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
43+
TYPE(*), DIMENSION(..), INTENT(IN) :: \fIbase\fP
44+
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
3845
.fi
3946
.SH INPUT PARAMETERS
4047
.ft R

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.\" -*- nroff -*-
22
.\" Copyright (c) 2015 Research Organization for Information Science
33
.\" and Technology (RIST). All rights reserved.
4+
.\" Copyright (c) 2020 FUJITSU LIMITED. All rights reserved.
45
.\" $COPYRIGHT$
56
.TH MPI_Win_get_info 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
67
.SH NAME
@@ -19,7 +20,7 @@ int MPI_Win_get_info(MPI_Win \fIwin\fP, MPI_Info \fI*info_used\fP)
1920
USE MPI
2021
! or the older form: INCLUDE 'mpif.h'
2122
MPI_WIN_GET_INFO(\fIWIN, INFO_USED, IERROR\fP)
22-
INTEGER \fICOMM, INFO_USED, IERROR \fP
23+
INTEGER \fIWIN, INFO_USED, IERROR \fP
2324
.
2425
.fi
2526
.SH Fortran 2008 Syntax

0 commit comments

Comments
 (0)